au.gov.nehta.vendorlibrary.hi.readreferencedata
Class ReadReferenceDataClient

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.hi.readreferencedata.ReadReferenceDataClient

public class ReadReferenceDataClient
extends java.lang.Object

An implementation of a Healthcare Identifiers (HI) - Provider Read Reference service client. This class may be used to connect to the Medicare HI Service to perform ReadReferenceData lookup.


Nested Class Summary
static class ReadReferenceDataClient.ArgumentValidator
          Validates the ReadReferenceData types are correct for webservice invocation.
 
Field Summary
static java.lang.String EMPTY
          Empty String variable.
 
Constructor Summary
ReadReferenceDataClient(java.lang.String readReferenceDataServiceEndpoint, au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId individualQualifiedId, javax.xml.ws.Holder<au.net.electronichealth.ns.hi.common.commoncoreelements._3_0.ProductType> productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory)
          Constructor which creates a new ReadReferenceDataClient with an endpoint and an SSL Socket Factory.
ReadReferenceDataClient(java.lang.String readReferenceDataServiceEndpoint, au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId individualQualifiedId, au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId organisationQualifiedId, javax.xml.ws.Holder<au.net.electronichealth.ns.hi.common.commoncoreelements._3_0.ProductType> productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory)
          Constructor which creates a new ReadReferenceDataClient with an endpoint and an SSL Socket Factory, with the optional contracted service providers HPI-O organisation qualified ID set.
 
Method Summary
 java.lang.String getLastSoapRequest()
          Getter for lastSoapRequest.
 java.lang.String getLastSoapResponse()
          Getter for lastSoapResponse.
 au.net.electronichealth.ns.hi.svc.hiproviderreadreferencedata._3_2_0.ReadReferenceDataResponse readReferenceData(au.net.electronichealth.ns.hi.svc.hiproviderreadreferencedata._3_2_0.ReadReferenceData readReferenceData)
          Retrieves the current acceptable HI reference data values for the provided readReferenceData .
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY

public static final java.lang.String EMPTY
Empty String variable.

See Also:
Constant Field Values
Constructor Detail

ReadReferenceDataClient

public ReadReferenceDataClient(java.lang.String readReferenceDataServiceEndpoint,
                               au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId individualQualifiedId,
                               javax.xml.ws.Holder<au.net.electronichealth.ns.hi.common.commoncoreelements._3_0.ProductType> productHeader,
                               java.security.PrivateKey signingPrivateKey,
                               java.security.cert.X509Certificate signingCertificate,
                               javax.net.ssl.SSLSocketFactory sslSocketFactory)
Constructor which creates a new ReadReferenceDataClient with an endpoint and an SSL Socket Factory.

Parameters:
readReferenceDataServiceEndpoint - the Web Service endpoint for the Medicare HI Service interface (Mandatory)
individualQualifiedId - The qualified user ID for connecting to the ReadReferenceData service (Mandatory)
productHeader - The product header data for connecting to the ReadReferenceData service (Mandatory)
signingPrivateKey - The private key to be used for signing (Mandatory)
signingCertificate - The certificate to be used for signing (Mandatory)
sslSocketFactory - the SSL Socket Factory to be used when connecting to the Web Service provider (Mandatory)

ReadReferenceDataClient

public ReadReferenceDataClient(java.lang.String readReferenceDataServiceEndpoint,
                               au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId individualQualifiedId,
                               au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId organisationQualifiedId,
                               javax.xml.ws.Holder<au.net.electronichealth.ns.hi.common.commoncoreelements._3_0.ProductType> productHeader,
                               java.security.PrivateKey signingPrivateKey,
                               java.security.cert.X509Certificate signingCertificate,
                               javax.net.ssl.SSLSocketFactory sslSocketFactory)
Constructor which creates a new ReadReferenceDataClient with an endpoint and an SSL Socket Factory, with the optional contracted service providers HPI-O organisation qualified ID set.

Parameters:
readReferenceDataServiceEndpoint - the Web Service endpoint for the Medicare HI Service interface (Mandatory)
individualQualifiedId - The qualified user ID for connecting to the ReadReferenceData service (Mandatory)
organisationQualifiedId - The qualified organisation ID for connecting to the ReadReferenceData service (Optional)
productHeader - The product header data for connecting to the ReadReferenceData service (Mandatory)
signingPrivateKey - The private key to be used for signing (Mandatory)
signingCertificate - The certificate to be used for signing (Mandatory)
sslSocketFactory - the SSL Socket Factory to be used when connecting to the Web Service provider (Mandatory)
Method Detail

readReferenceData

public final au.net.electronichealth.ns.hi.svc.hiproviderreadreferencedata._3_2_0.ReadReferenceDataResponse readReferenceData(au.net.electronichealth.ns.hi.svc.hiproviderreadreferencedata._3_2_0.ReadReferenceData readReferenceData)
                                                                                                                       throws au.net.electronichealth.ns.hi.svc.hiproviderreadreferencedata._3_2_0.StandardErrorMsg
Retrieves the current acceptable HI reference data values for the provided readReferenceData .
These element include but are not limited to
  • providerTypeCode
  • providerSpeciality
  • providerSpecialisation
  • organisationTypeCode
  • organisationService
  • organisationServiceUnit
  • operatingSystem
  • Parameters:
    readReferenceData - containing a list of element names. (Mandatory)
    Returns:
    Zero or more acceptable reference values for the referenceList.
    Throws:
    au.net.electronichealth.ns.hi.svc.hiproviderreadreferencedata._3_2_0.StandardErrorMsg - in an event of web service failure.

    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)