org.qas.api

Class ApiServiceRequest

java.lang.Object

org.qas.api.ApiServiceRequest

Direct Known Subclasses:

AbstractQTestApiServiceRequest, ActivateAutomationAgentRequest, AssignToProjectRequest, AttachmentRequest, AuthenticateRequest, AutomationTestLogRequest, AutomationTestLogsRequest, CreateArtifactLinkRequest, CreateAutomationAgentRequest, CreateAutomationHostRequest, CreateBuildRequest, CreateCustomFieldRequest, CreateDefectRequest, CreateObjectCommentRequest, CreateProjectRequest, CreateReleaseRequest, CreateRequirementRequest, CreateTestStepRequest, CreateUserRequest, DeleteAutomationAgentRequest, GetArtifactLinkRequest, GetClientRequest, GetFieldsRequest, GetRequirementFieldsRequest, GetTestCaseFieldsRequest, GetTestStepRequest, GetUserPermissionsRequest, GetUserProfileRequest, LinkTestCaseRequirementRequest, ListExecutionStatusRequest, ListJobRequest, ListProjectRequest, ListTestStepRequest, ListUserPermissionsRequest, ListUserRequest, OAuthAuthenticateRequest, OAuthTokenRefreshRequest, OAuthTokenStatusRequest, PagingRequest, PingAutomationHostRequest, QueueProcessingResponseRequest, SetSessionUrlRequest, SubmitTestLogRequest, UpdateAutomationAgentRequest, UpdateCustomFieldRequest, UpdateJobStatusRequest, UpdateSystemFieldRequest, ValidateTokenRequest

public abstract class ApiServiceRequest
extends java.lang.Object

ApiServiceRequest

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ApiServiceRequest()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	copyPrivateRequestParameters()
Credentials	getCredentials()
RequestClientOptions	getRequestClientOptions()
void	setCredentials(Credentials credentials) Sets the optional credentials to use to sign this request, overriding the default credentials set at a client level.
java.lang.String	toString()
ApiServiceRequest	withCredentials(Credentials credentials) Sets the optional credentials to use to sign this request, overriding the default credentials set at a client level and return the updated service request object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiServiceRequest

public ApiServiceRequest()

Method Detail

getCredentials

public Credentials getCredentials()

Returns:

the optional credentials to use to sign this request, overriding the default credentials set at the client level.

setCredentials

public void setCredentials(Credentials credentials)

Sets the optional credentials to use to sign this request, overriding the default credentials set at a client level.

Parameters:

credentials - The optional credentials to use for this request.

withCredentials

public ApiServiceRequest withCredentials(Credentials credentials)

Sets the optional credentials to use to sign this request, overriding the default credentials set at a client level and return the updated service request object.

Parameters:

credentials - the optional credentials to use for this request.

Returns:

the updated service request object with the new credentials.

copyPrivateRequestParameters

public java.util.Map<java.lang.String,java.lang.String> copyPrivateRequestParameters()

Returns:

the basic request parameter information.

getRequestClientOptions

public RequestClientOptions getRequestClientOptions()

Returns:

the options stored with this request object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object