com.esri.gpt.catalog.arcims
Class ImsRequest

java.lang.Object
  com.esri.gpt.catalog.arcims.ImsRequest

Direct Known Subclasses:

HarvestRequest, PublishServiceRequest

public class ImsRequest
extends Object

Super-class for an ArcIMS request.

Field Summary

static String	ACTION_STATUS_ERROR
static String	ACTION_STATUS_NONE
static String	ACTION_STATUS_OK
static String	ACTION_STATUS_REPLACED
static String	ACTION_STATUS_UNKNOWN

Constructor Summary

protected

ImsRequest() Default constructor.

Method Summary

protected void	executeRequest() Executes an ArcIMS service request and parses the response.
protected void	executeRequest(ImsClient client) Executes an ArcIMS service request and parses the response.
String	getActionStatus() Gets the action status for the request.
protected String	getAxlRequest() Gets the ArcIMS axl request.
protected String	getAxlResponse() Gets the ArcIMS axl response.
Credentials	getCredentials() Gets the credentials for the user.
ImsService	getService() Gets the service to which the request will be sent.
protected ImsClient	makeClient(RequestContext context, Publisher publisher) Makes a suitable client for the service.
protected void	onEndSaxElement(String lowerCaseTagName, String characters) Triggered when a SAX element is ended during the parsing of an axl response.
protected void	onStartSaxElement(String lowerCaseTagName, Attributes attributes) Triggered when a SAX element is started during the parsing of an axl response.
protected void	setActionStatus(String actionStatus) Sets the action status for the request.
protected void	setAxlRequest(String axlRequest) Sets the ArcIMS axl request.
protected void	setAxlResponse(String axlResponse) Sets the ArcIMS axl response.
void	setCredentials(Credentials credentials) Sets the credentials for the user.
void	setService(ImsService service) Sets the service to which the request will be sent.
boolean	wasActionOK() Returns true if the action was OK.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_STATUS_ERROR

public static final String ACTION_STATUS_ERROR

See Also:

Constant Field Values

ACTION_STATUS_NONE

public static final String ACTION_STATUS_NONE

See Also:

Constant Field Values

ACTION_STATUS_OK

public static final String ACTION_STATUS_OK

See Also:

Constant Field Values

ACTION_STATUS_REPLACED

public static final String ACTION_STATUS_REPLACED

See Also:

Constant Field Values

ACTION_STATUS_UNKNOWN

public static final String ACTION_STATUS_UNKNOWN

See Also:

Constant Field Values

Constructor Detail

ImsRequest

protected ImsRequest()

Default constructor.

Method Detail

getActionStatus

public String getActionStatus()

Gets the action status for the request.

Returns:

the action status

setActionStatus

protected void setActionStatus(String actionStatus)

Sets the action status for the request.

Parameters:

actionStatus - the action status

getAxlRequest

protected String getAxlRequest()

Gets the ArcIMS axl request.

Returns:

the axl request

setAxlRequest

protected void setAxlRequest(String axlRequest)

Sets the ArcIMS axl request.

Parameters:

axlRequest - the axl request

getAxlResponse

protected String getAxlResponse()

Gets the ArcIMS axl response.

Returns:

the axl response

setAxlResponse

protected void setAxlResponse(String axlResponse)

Sets the ArcIMS axl response.

Parameters:

axlResponse - the axl response

getCredentials

public Credentials getCredentials()

Gets the credentials for the user.

Returns:

the credentials

setCredentials

public void setCredentials(Credentials credentials)

Sets the credentials for the user.

Parameters:

credentials - the credentials

getService

public ImsService getService()

Gets the service to which the request will be sent.

Returns:

the service

setService

public void setService(ImsService service)

Sets the service to which the request will be sent.

Parameters:

service - the service

wasActionOK

public boolean wasActionOK()

Returns true if the action was OK.

Returns:

true if the action was OK.

executeRequest

protected void executeRequest()
                       throws ImsServiceException

Executes an ArcIMS service request and parses the response.

Throws:

ImsServiceException - if an exception occurs

executeRequest

protected void executeRequest(ImsClient client)
                       throws ImsServiceException

Executes an ArcIMS service request and parses the response.

Throws:

ImsServiceException - if an exception occurs

makeClient

protected ImsClient makeClient(RequestContext context,
                               Publisher publisher)

Makes a suitable client for the service.

Parameters:

context - the active request context (only required for socket request against the GPT_Browse_Service or GPT_Publish_Service

publisher - the publisher associated with the request (only required for a socket request against the GPT_Publish_Service

Returns:

the client

onEndSaxElement

protected void onEndSaxElement(String lowerCaseTagName,
                               String characters)

Triggered when a SAX element is ended during the parsing of an axl response.

Parameters:

lowerCaseTagName - the lower-case tag name of the element

characters - the text node value of the element

onStartSaxElement

protected void onStartSaxElement(String lowerCaseTagName,
                                 Attributes attributes)

Triggered when a SAX element is started during the parsing of an axl response.

Parameters:

lowerCaseTagName - the lower-case tag name of the element

attributes - the element attributes