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

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.hi.client.ClientBase<T>
      extended by au.gov.nehta.vendorlibrary.hi.client.BaseClient_3<au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.ProviderReadReferenceDataPortType>
          extended by au.gov.nehta.vendorlibrary.hi.readreferencedata.ReadReferenceDataClient

public class ReadReferenceDataClient
extends BaseClient_3<au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.ProviderReadReferenceDataPortType>

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
 
Fields inherited from class au.gov.nehta.vendorlibrary.hi.client.BaseClient_3
individualQualifiedId, organisationQualifiedId, productHeader
 
Fields inherited from class au.gov.nehta.vendorlibrary.hi.client.ClientBase
certificateValidator, EMPTY, loggingHandler, port, QUALIFIED_ID_MISSING, signingCertificate, signingPrivateKey, SSL_SOCKET_FACTORY, SSL_SOCKET_FACTORY_INTERNAL, sslSocketFactory
 
Constructor Summary
ReadReferenceDataClient(java.lang.String readReferenceDataServiceEndpoint, 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.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId, au.net.electronichealth.ns.hi.xsd.common.commoncoreelements._3.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, QualifiedId individualQualifiedId, 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 serviceEndpoint, au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId, au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId organisationQualifiedId, au.net.electronichealth.ns.hi.xsd.common.commoncoreelements._3.ProductType productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory, au.gov.nehta.xsp.CertificateValidator certificateValidator)
          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.
ReadReferenceDataClient(java.lang.String serviceEndpoint, QualifiedId individualQualifiedId, QualifiedId organisationQualifiedId, ProductType productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory, au.gov.nehta.xsp.CertificateValidator certificateValidator)
          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
 au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.ReadReferenceDataResponse readReferenceData(au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.ReadReferenceData readReferenceData)
          Retrieves the current acceptable HI reference data values for the provided readReferenceData .
 au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.ReadReferenceDataResponse readReferenceData(au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.ReadReferenceData readReferenceData, QualifiedId individualId)
          Retrieves the current acceptable HI reference data values for the provided readReferenceData .
 
Methods inherited from class au.gov.nehta.vendorlibrary.hi.client.BaseClient_3
checkUserID, getTimestampHeader, hasNoOrganisationQualifiedId
 
Methods inherited from class au.gov.nehta.vendorlibrary.hi.client.ClientBase
configureEndpoint, getBindingProvider, getLastSoapRequest, getLastSoapResponse, getPort, isEmpty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReadReferenceDataClient

public ReadReferenceDataClient(java.lang.String readReferenceDataServiceEndpoint,
                               au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId,
                               au.net.electronichealth.ns.hi.xsd.common.commoncoreelements._3.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 serviceEndpoint,
                               au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId,
                               au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId organisationQualifiedId,
                               au.net.electronichealth.ns.hi.xsd.common.commoncoreelements._3.ProductType productHeader,
                               java.security.PrivateKey signingPrivateKey,
                               java.security.cert.X509Certificate signingCertificate,
                               javax.net.ssl.SSLSocketFactory sslSocketFactory,
                               au.gov.nehta.xsp.CertificateValidator certificateValidator)
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:
serviceEndpoint - 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)
certificateValidator - (optional) a user supplied validator to authenticate the response certificate.

ReadReferenceDataClient

public ReadReferenceDataClient(java.lang.String readReferenceDataServiceEndpoint,
                               QualifiedId individualQualifiedId,
                               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,
                               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)
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 serviceEndpoint,
                               QualifiedId individualQualifiedId,
                               QualifiedId organisationQualifiedId,
                               ProductType productHeader,
                               java.security.PrivateKey signingPrivateKey,
                               java.security.cert.X509Certificate signingCertificate,
                               javax.net.ssl.SSLSocketFactory sslSocketFactory,
                               au.gov.nehta.xsp.CertificateValidator certificateValidator)
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:
serviceEndpoint - 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)
certificateValidator - (optional) a user supplied validator to authenticate the response certificate.
Method Detail

readReferenceData

public final au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.ReadReferenceDataResponse readReferenceData(au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.ReadReferenceData readReferenceData)
                                                                                                                   throws au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.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.providerreadreferencedata._3_2.StandardErrorMsg - in an event of web service failure.

    readReferenceData

    public final au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.ReadReferenceDataResponse readReferenceData(au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.ReadReferenceData readReferenceData,
                                                                                                                              QualifiedId individualId)
                                                                                                                       throws au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.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)
    individualId - the qualified user id of the user making the request
    Returns:
    Zero or more acceptable reference values for the referenceList.
    Throws:
    au.net.electronichealth.ns.hi.svc.providerreadreferencedata._3_2.StandardErrorMsg - in an event of web service failure.