com.github.hi_fi.httprequestlibrary.keywords.Session Maven / Gradle / Ivy

Go to download
package com.github.hi_fi.httprequestlibrary.keywords;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.robotframework.javalib.annotation.ArgumentNames;
import org.robotframework.javalib.annotation.RobotKeyword;
import org.robotframework.javalib.annotation.RobotKeywords;

import com.github.hi_fi.httpclient.domain.Authentication;
import com.github.hi_fi.httpclient.RestClient;
import com.github.hi_fi.httprequestlibrary.utils.Robot;
import com.github.hi_fi.httprequestlibrary.utils.RobotLogger;

@RobotKeywords
public class Session {

	@RobotKeyword("Create a HTTP session to a server\n\n"
			 + "``url`` Base url of the server\n\n"
			 + "``alias`` Robot Framework alias to identify the session\n\n"
			 + "``headers`` Dictionary of default headers\n\n"
			 + "``auth`` List of username & password for HTTP Basic Auth\n\n"
			 + "``timeout`` Connection timeout\n\n"
			 + "\n\n"
			 + "``proxies`` Dictionary that contains proxy urls for HTTP and HTTPS communication\n\n"
			 + "``verify`` Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.\n\n"
			 + "``debug`` Enable http verbosity option more information.\n\n")
	@ArgumentNames({ "alias", "url", "headers={}", "cookies=None", "auth=None", "timeout=None", "proxies=None",
			"verify=False", "debug=False" })
	public void createSession(String alias, String url, String... params) {
		RestClient rc = new RestClient();
		Map headers = Robot.getParamsValue(params, 0, new HashMap());
		String verify = Robot.getParamsValue(params, 5, "False");
		RobotLogger.setDebugToAll(Boolean.parseBoolean(Robot.getParamsValue(params, 6, "False")));
		Authentication auth = Authentication
				.getAuthentication(Robot.getParamsValue(params, 2, (List) new ArrayList()));
		rc.createSession(alias, url, headers, auth, verify);
	}

	@RobotKeyword("Create a HTTP session to a server\n\n"
			 + "``url`` Base url of the server\n\n"
			 + "``alias`` Robot Framework alias to identify the session\n\n"
			 + "``headers`` Dictionary of default headers\n\n"
			 + "``auth`` List of username & password for HTTP Digest Auth\n\n"
			 + "``timeout`` Connection timeout\n\n"
			 + "\n\n"
			 + "``proxies`` Dictionary that contains proxy urls for HTTP and HTTPS communication\n\n"
			 + "``verify`` Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.\n\n"
			 + "``debug`` Enable http verbosity option more information.\n\n")
	@ArgumentNames({ "alias", "url", "headers={}", "cookies=None", "auth=None", "timeout=None", "proxies=None",
			"verify=False", "debug=False" })
	public void createDigestSession(String alias, String url, String... params) {
		RestClient rc = new RestClient();
		Map headers = Robot.getParamsValue(params, 0, new HashMap());
		String verify = Robot.getParamsValue(params, 5, "False");
		RobotLogger.setDebugToAll(Boolean.parseBoolean(Robot.getParamsValue(params, 6, "False")));
		Authentication auth = Authentication.getAuthentication(
				Robot.getParamsValue(params, 2, (List) new ArrayList()), Authentication.Type.DIGEST);
		rc.createSession(alias, url, headers, auth, verify);
	}

}