au.gov.nehta.vendorlibrary.smd
Class TransportResponseRetrievalClient

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.smd.TransportResponseRetrievalClient

public class TransportResponseRetrievalClient
extends java.lang.Object

An implementation of a Transport Response Retrieval client.
Code Example:

     TransportResponseRetrievalClient trrClient = new TransportResponseRetrievalClient(sslSocketFactory);

 List removeResultTypes = trrClient.remove(forceRemoval, trrReceiverOrganisation, trasnportResponseIdList,
 trrEndpointURL);

 TransportResponseListType transportResponseListType = trrClient.retrieve(trrReceiverOrganisation, allAvailable, limit,
 trrEndpointURL);

     


Nested Class Summary
static class TransportResponseRetrievalClient.ArgumentValidator
          Validates parameters are correct for the various operations.
 
Constructor Summary
TransportResponseRetrievalClient(javax.net.ssl.SSLSocketFactory sslSocketFactory)
          Default constructor.
 
Method Summary
 java.lang.String getLastSoapRequest()
          Getter for lastSoapRequest.
 java.lang.String getLastSoapResponse()
          Getter for lastSoapResponse.
 java.util.List<au.net.electronichealth.ns.trr.tls.v2010.RemoveResultType> remove(boolean force, java.lang.String organisation, java.util.List<java.lang.String> responseId, java.lang.String endpoint)
          Performs the Transport Response Retrieval remove operation.
 au.net.electronichealth.ns.trr.tls.v2010.TransportResponseListType retrieve(java.lang.String organisation, boolean allAvailable, int limit, java.lang.String endpoint)
          Performs the Transport Response Retrieval retrieve operation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TransportResponseRetrievalClient

public TransportResponseRetrievalClient(javax.net.ssl.SSLSocketFactory sslSocketFactory)
Default constructor.

Parameters:
sslSocketFactory - the SSL Socket Factory to be used when connecting to the Web Service provider (Mandatory)
Method Detail

retrieve

public final au.net.electronichealth.ns.trr.tls.v2010.TransportResponseListType retrieve(java.lang.String organisation,
                                                                                         boolean allAvailable,
                                                                                         int limit,
                                                                                         java.lang.String endpoint)
                                                                                  throws au.net.electronichealth.ns.trr.tls.v2010.RetrieveErrorMsg,
                                                                                         au.net.electronichealth.ns.trr.tls.v2010.StandardErrorMsg
Performs the Transport Response Retrieval retrieve operation.

Parameters:
organisation - the invoker's organisation identifier (Mandatory)
allAvailable - flag to retrieve previously removed transport responses if desired.
limit - zero or a positive integer to indicate the maximum number of items to retrieve.
endpoint - the Transport Response Retrieval (TRR) endpoint (Mandatory)
Returns:
a list of TransportResponseListType for a successful retrieval
Throws:
au.net.electronichealth.ns.trr.tls.v2010.RetrieveErrorMsg - if an error occurred in processing the retrieve request
au.net.electronichealth.ns.trr.tls.v2010.StandardErrorMsg - in an event of error other than RetrieveErrorMsg

remove

public final java.util.List<au.net.electronichealth.ns.trr.tls.v2010.RemoveResultType> remove(boolean force,
                                                                                              java.lang.String organisation,
                                                                                              java.util.List<java.lang.String> responseId,
                                                                                              java.lang.String endpoint)
                                                                                       throws au.net.electronichealth.ns.trr.tls.v2010.RemoveErrorMsg,
                                                                                              au.net.electronichealth.ns.trr.tls.v2010.StandardErrorMsg
Performs the Transport Response Retrieval remove operation.

Parameters:
force - flag to force removal
organisation - the invoker's organisation identifier (Mandatory)
responseId - list of responseId to be removed (Mandatory)
endpoint - the Transport Response Retrieval (TRR) endpoint (Mandatory)
Returns:
List if the web service invocation is successful.
Throws:
au.net.electronichealth.ns.trr.tls.v2010.RemoveErrorMsg - if one ore more responseId do not identify a TransportResponse
au.net.electronichealth.ns.trr.tls.v2010.StandardErrorMsg - if the web service invocation fails due to a standard error

getLastSoapResponse

public final java.lang.String getLastSoapResponse()
Getter for lastSoapResponse.

Returns:
lastSoapResponse the lastSoapResponse instance variable

getLastSoapRequest

public final java.lang.String getLastSoapRequest()
Getter for lastSoapRequest.

Returns:
lastSoapRequest the lastSoapRequest instance variable (Mandatory)