Package org.jenkinsci.plugins.ansible_tower.util

Class TowerConnector

java.lang.Object

org.jenkinsci.plugins.ansible_tower.util.TowerConnector

All Implemented Interfaces:

Serializable

public class TowerConnector
extends Object
implements Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_BASE_PATH_AAP_CONTROLLER
static final String	API_BASE_PATH_LEGACY
static final String	API_GATEWAY_TOKEN_ENDPOINT
static final int	GET
static final String	JOB_TEMPLATE_TYPE
static final int	PATCH
static final int	POST
static final String	WORKFLOW_TEMPLATE_TYPE

Constructor Summary

Constructors

Constructor	Description
TowerConnector(String url, String username, String password)
TowerConnector(String url, String username, String password, String oauthToken, Boolean trustAllCerts, Boolean debug)
TowerConnector(String url, String username, String password, String oauthToken, Boolean trustAllCerts, Boolean debug, String apiBasePath)

Method Summary

Modifier and Type	Method	Description
void	cancelJob(long jobID, String templateType)
void	checkTemplateType(String templateType)
String	convertPotentialStringToID(String idToCheck, String api_endpoint)
HashMap<String,String>	getJenkinsExports()
net.sf.json.JSONObject	getJobTemplate(String jobTemplate, String templateType)
String	getJobURL(long myJobID, String templateType)
Vector<String>	getLogEvents(long jobID, String templateType)
String	getMethodName(int methodId)
String	getProjectSyncURL(long syncID)
String	getURL()
void	getVersion()
boolean	isJobCommpleted(long jobID, String templateType)	Deprecated. Use isJobCompleted
boolean	isJobCompleted(long jobID, String templateType)
boolean	isJobFailed(long jobID, String templateType)
Vector<String>	logLine(String output)
org.apache.http.HttpResponse	makeRequest(int requestType, String endpoint, net.sf.json.JSONObject body, boolean noAuth)
net.sf.json.JSONObject	rawLookupByString(String idToCheck, String api_endpoint)
void	releaseToken()
void	setConsole(PrintStream console)
void	setDebug(boolean debug)
void	setGetFullLogs(boolean getFullLogs)
void	setGetWorkflowChildLogs(boolean importChildWorkflowLogs)
void	setRemoveColor(boolean removeColor)
void	setTrustAllCerts(boolean trustAllCerts)	Deprecated. Certificate validation is always enforced.
long	submitTemplate(long jobTemplate, String extraVars, String limit, String jobTags, String skipJobTags, String jobType, String inventory, String credential, String scmBranch, String templateType)
void	testConnection()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

GET

public static final int GET

See Also:

• Constant Field Values

POST

public static final int POST

See Also:

• Constant Field Values

PATCH

public static final int PATCH

See Also:

• Constant Field Values

JOB_TEMPLATE_TYPE

public static final String JOB_TEMPLATE_TYPE

See Also:

• Constant Field Values

WORKFLOW_TEMPLATE_TYPE

public static final String WORKFLOW_TEMPLATE_TYPE

See Also:

• Constant Field Values

API_BASE_PATH_LEGACY

public static final String API_BASE_PATH_LEGACY

See Also:

• Constant Field Values

API_BASE_PATH_AAP_CONTROLLER

public static final String API_BASE_PATH_AAP_CONTROLLER

See Also:

• Constant Field Values

API_GATEWAY_TOKEN_ENDPOINT

public static final String API_GATEWAY_TOKEN_ENDPOINT

See Also:

• Constant Field Values

Constructor Details

TowerConnector

public TowerConnector(String url,
 String username,
 String password)

TowerConnector

public TowerConnector(String url,
 String username,
 String password,
 String oauthToken,
 Boolean trustAllCerts,
 Boolean debug)

TowerConnector

public TowerConnector(String url,
 String username,
 String password,
 String oauthToken,
 Boolean trustAllCerts,
 Boolean debug,
 String apiBasePath)

Method Details

setTrustAllCerts

@Deprecated
public void setTrustAllCerts(boolean trustAllCerts)

Deprecated.

Certificate validation is always enforced.

setDebug

public void setDebug(boolean debug)

setConsole

public void setConsole(PrintStream console)

setRemoveColor

public void setRemoveColor(boolean removeColor)

setGetWorkflowChildLogs

public void setGetWorkflowChildLogs(boolean importChildWorkflowLogs)

setGetFullLogs

public void setGetFullLogs(boolean getFullLogs)

getJenkinsExports

public HashMap<String,String> getJenkinsExports()

makeRequest

public org.apache.http.HttpResponse makeRequest(int requestType,
 String endpoint,
 net.sf.json.JSONObject body,
 boolean noAuth)
                                         throws AnsibleTowerException,
AnsibleTowerItemDoesNotExist

Throws:

AnsibleTowerException

AnsibleTowerItemDoesNotExist

getURL

public String getURL()

getVersion

public void getVersion()
                throws AnsibleTowerException

Throws:

AnsibleTowerException

testConnection

public void testConnection()
                    throws AnsibleTowerException

Throws:

AnsibleTowerException

convertPotentialStringToID

public String convertPotentialStringToID(String idToCheck,
 String api_endpoint)
                                  throws AnsibleTowerException,
AnsibleTowerItemDoesNotExist

Throws:

AnsibleTowerException

AnsibleTowerItemDoesNotExist

rawLookupByString

public net.sf.json.JSONObject rawLookupByString(String idToCheck,
 String api_endpoint)
                                         throws AnsibleTowerException,
AnsibleTowerItemDoesNotExist

Throws:

AnsibleTowerException

AnsibleTowerItemDoesNotExist

getJobTemplate

public net.sf.json.JSONObject getJobTemplate(String jobTemplate,
 String templateType)
                                      throws AnsibleTowerException

Throws:

AnsibleTowerException

submitTemplate

public long submitTemplate(long jobTemplate,
 String extraVars,
 String limit,
 String jobTags,
 String skipJobTags,
 String jobType,
 String inventory,
 String credential,
 String scmBranch,
 String templateType)
                    throws AnsibleTowerException

Throws:

AnsibleTowerException

checkTemplateType

public void checkTemplateType(String templateType)
                       throws AnsibleTowerException

Throws:

AnsibleTowerException

isJobCompleted

public boolean isJobCompleted(long jobID,
 String templateType)
                       throws AnsibleTowerException

Throws:

AnsibleTowerException

cancelJob

public void cancelJob(long jobID,
 String templateType)
               throws AnsibleTowerException

Throws:

AnsibleTowerException

isJobCommpleted

@Deprecated
public boolean isJobCommpleted(long jobID,
 String templateType)
                        throws AnsibleTowerException

Deprecated.

Use isJobCompleted

Throws:

AnsibleTowerException

getLogEvents

public Vector<String> getLogEvents(long jobID,
 String templateType)
                            throws AnsibleTowerException

Throws:

AnsibleTowerException

logLine

public Vector<String> logLine(String output)
                       throws AnsibleTowerException

Throws:

AnsibleTowerException

isJobFailed

public boolean isJobFailed(long jobID,
 String templateType)
                    throws AnsibleTowerException

Throws:

AnsibleTowerException

getJobURL

public String getJobURL(long myJobID,
 String templateType)

getProjectSyncURL

public String getProjectSyncURL(long syncID)

releaseToken

public void releaseToken()

getMethodName

public String getMethodName(int methodId)