au.gov.nehta.vendorlibrary.pcehr.clients.documentexchange
Class RemoveDocumentClient

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.pcehr.clients.common.Client<au.net.electronichealth.ns.pcehr.svc.removedocument._1.RemoveDocumentPortType>
      extended by au.gov.nehta.vendorlibrary.pcehr.clients.documentexchange.RemoveDocumentClient

public final class RemoveDocumentClient
extends Client<au.net.electronichealth.ns.pcehr.svc.removedocument._1.RemoveDocumentPortType>

A JAX-WS client to the PCEHR 'Remove Document' web service.


Constructor Summary
RemoveDocumentClient(javax.net.ssl.SSLSocketFactory sslSocketFactory, java.security.cert.X509Certificate x509Certificate, au.gov.nehta.xsp.CertificateVerifier certificateVerifier, java.security.PrivateKey privateKey, java.lang.String endpointAddress, boolean setLoggingEnabled)
          Constructor - accepts an optional certificate verifier.
RemoveDocumentClient(javax.net.ssl.SSLSocketFactory sslSocketFactory, java.security.cert.X509Certificate x509Certificate, java.security.PrivateKey privateKey, java.lang.String endpointAddress, boolean setLoggingEnabled)
          Constructor - no certificate verification performed.
 
Method Summary
 au.net.electronichealth.ns.pcehr.xsd.interfaces.removedocument._1.RemoveDocumentResponse removeDocument(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader, java.lang.String documentId, au.net.electronichealth.ns.pcehr.xsd.interfaces.removedocument._1.RemoveDocument.DocumentRemovalReason removalReason)
          Remove a document from the document repository/registry.
 
Methods inherited from class au.gov.nehta.vendorlibrary.pcehr.clients.common.Client
getHandlerChain, getLastSoapRequest, getLastSoapResponse, getPort, setMTOMEnabled, setProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RemoveDocumentClient

public RemoveDocumentClient(javax.net.ssl.SSLSocketFactory sslSocketFactory,
                            java.security.cert.X509Certificate x509Certificate,
                            java.security.PrivateKey privateKey,
                            java.lang.String endpointAddress,
                            boolean setLoggingEnabled)
Constructor - no certificate verification performed.

Parameters:
sslSocketFactory - the SSLSocketFactory to be used when connecting to the web service provider (mandatory).
x509Certificate - the certificate key to be used for signing (mandatory)
privateKey - the private key to be used for signing (mandatory)
endpointAddress - the endpoint address of the web service (mandatory).
setLoggingEnabled - set to true to enable logging (mandatory).

RemoveDocumentClient

public RemoveDocumentClient(javax.net.ssl.SSLSocketFactory sslSocketFactory,
                            java.security.cert.X509Certificate x509Certificate,
                            au.gov.nehta.xsp.CertificateVerifier certificateVerifier,
                            java.security.PrivateKey privateKey,
                            java.lang.String endpointAddress,
                            boolean setLoggingEnabled)
Constructor - accepts an optional certificate verifier.

Parameters:
sslSocketFactory - the SSLSocketFactory to be used when connecting to the web service provider (mandatory).
x509Certificate - the certificate key to be used for signing (mandatory)
certificateVerifier - CertificateVerifier implementation (optional).
privateKey - the private key to be used for signing (mandatory)
endpointAddress - the endpoint address of the web service (mandatory).
setLoggingEnabled - set to true to enable logging (mandatory).
Method Detail

removeDocument

public au.net.electronichealth.ns.pcehr.xsd.interfaces.removedocument._1.RemoveDocumentResponse removeDocument(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader,
                                                                                                               java.lang.String documentId,
                                                                                                               au.net.electronichealth.ns.pcehr.xsd.interfaces.removedocument._1.RemoveDocument.DocumentRemovalReason removalReason)
                                                                                                        throws au.net.electronichealth.ns.pcehr.svc.removedocument._1.StandardErrorMsg
Remove a document from the document repository/registry.

Parameters:
commonHeader - PCEHR common header
documentId - Unique identifier of the document to be removed.
removalReason - Reason for the removal
Returns:
Response status type
Throws:
au.net.electronichealth.ns.pcehr.svc.removedocument._1.StandardErrorMsg - On operation failure.