com.aemo.msats.ws

Class NMIDiscovery

java.lang.Object

com.aemo.msats.ws.NMIDiscovery

public class NMIDiscovery
extends java.lang.Object

This class provides a wrapper method for each variant of the MSATS NMI Discovery web service.

Constructor Summary

Constructors

Constructor and Description
NMIDiscovery() Construct an instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
void	doNmiDiscovery(java.lang.String dataFilename, java.lang.String requestContentType) Make a request to the NMI Discovery web service by POSTing an aseXML file from the inbox.
java.lang.String	doNmiDiscoveryAddress(java.lang.String jurisdictionCode, java.lang.String transactionId, java.lang.String buildingOrPropertyName, java.lang.String locationDescriptor, java.lang.String lotNumber, java.lang.String flatOrUnitType, java.lang.String flatOrUnitNumber, java.lang.String floorOrLevelType, java.lang.String floorOrLevelNumber, java.lang.String houseNumber, java.lang.String houseNumberSuffix, java.lang.String streetName, java.lang.String streetSuffix, java.lang.String streetType, java.lang.String suburbOrPlaceOrLocality, java.lang.String postcode, java.lang.String stateOrTerritory) Make a GET request to the NMI Discovery web service to search for NMIs by address.
java.lang.String	doNmiDiscoveryDpid(java.lang.String jurisdictionCode, java.lang.String transactionId, java.lang.String deliveryPointIdentifier) Make a GET request to the NMI Discovery web service to search for NMIs by delivery point identifier.
java.lang.String	doNmiDiscoveryMeterSerial(java.lang.String jurisdictionCode, java.lang.String transactionId, java.lang.String meterSerialNumber) Make a GET request to the NMI Discovery web service to search for NMIs by meter serial number.
java.lang.String	getResponse() This method provides the web service response as a string.
java.lang.String	getResponseCharset() Reports the character set from the Content-Type header.
int	getResponseCode() Report the HTTP response code.
java.lang.String	getResponseFilename() Reports the filename from the Content-Disposition header.
java.lang.String	getResponseReason() Report the HTTP response reason.
java.lang.String	getResponseType() Reports the mime-type from the Content-Type header.
void	writeResponse() Write the web service response to a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

NMIDiscovery

public NMIDiscovery()
             throws ApplicationException

Construct an instance of this class.

Throws:

ApplicationException - if the instance cannot be initialised.

Method Detail

doNmiDiscovery

public void doNmiDiscovery(java.lang.String dataFilename,
                  java.lang.String requestContentType)
                    throws ApplicationException

Make a request to the NMI Discovery web service by POSTing an aseXML file from the inbox. The file should contain a single, valid NMIDiscoveryRequest transaction. If the web service request is successful, the response file is written to the outbox.

Parameters:

dataFilename - is the file to post from the inbox.

requestContentType - defines the file type as XML or ZIP.

Throws:

ApplicationException - when something goes wrong.

doNmiDiscoveryDpid

public java.lang.String doNmiDiscoveryDpid(java.lang.String jurisdictionCode,
                                  java.lang.String transactionId,
                                  java.lang.String deliveryPointIdentifier)
                                    throws ApplicationException

Make a GET request to the NMI Discovery web service to search for NMIs by delivery point identifier.

Parameters:

jurisdictionCode - nominates a jurisdiction to search.

transactionId - identifies requestor's transaction.

deliveryPointIdentifier - is the postal delivery point to search for.

Returns:

the XML web service response

Throws:

ApplicationException - when something goes wrong.

doNmiDiscoveryMeterSerial

public java.lang.String doNmiDiscoveryMeterSerial(java.lang.String jurisdictionCode,
                                         java.lang.String transactionId,
                                         java.lang.String meterSerialNumber)
                                           throws ApplicationException

Make a GET request to the NMI Discovery web service to search for NMIs by meter serial number.

Parameters:

jurisdictionCode - nominates a jurisdiction to search.

transactionId - identifies requestor's transaction.

meterSerialNumber - is the meter serial number to search for.

Returns:

the XML web service response

Throws:

ApplicationException - when something goes wrong.

doNmiDiscoveryAddress

public java.lang.String doNmiDiscoveryAddress(java.lang.String jurisdictionCode,
                                     java.lang.String transactionId,
                                     java.lang.String buildingOrPropertyName,
                                     java.lang.String locationDescriptor,
                                     java.lang.String lotNumber,
                                     java.lang.String flatOrUnitType,
                                     java.lang.String flatOrUnitNumber,
                                     java.lang.String floorOrLevelType,
                                     java.lang.String floorOrLevelNumber,
                                     java.lang.String houseNumber,
                                     java.lang.String houseNumberSuffix,
                                     java.lang.String streetName,
                                     java.lang.String streetSuffix,
                                     java.lang.String streetType,
                                     java.lang.String suburbOrPlaceOrLocality,
                                     java.lang.String postcode,
                                     java.lang.String stateOrTerritory)
                                       throws ApplicationException

Make a GET request to the NMI Discovery web service to search for NMIs by address. Either a suburbOrPlaceOrLocality, a postcode, or both values must be provided. A stateOrTerritory value must be provided. Other address parameters may be null.

Parameters:

jurisdictionCode - nominates a jurisdiction to search.

transactionId - identifies requestor's transaction.

buildingOrPropertyName -

locationDescriptor -

lotNumber -

flatOrUnitType -

flatOrUnitNumber -

floorOrLevelType -

floorOrLevelNumber -

houseNumber -

houseNumberSuffix -

streetName -

streetSuffix -

streetType -

suburbOrPlaceOrLocality -

postcode -

stateOrTerritory -

Returns:

the XML web service response

Throws:

ApplicationException - when something goes wrong.

getResponseCode

public int getResponseCode()

Report the HTTP response code. A value of 200 indicates a successful web service request. Other values indicate an error.

Returns:

the HTTP response code.

getResponseReason

public java.lang.String getResponseReason()

Report the HTTP response reason.

Returns:

the HTTP response reason.

getResponseType

public java.lang.String getResponseType()

Reports the mime-type from the Content-Type header. If a Content-Type header was not provided then a default value of 'text/xml' is returned.

Returns:

the character set from the Content-Type header.

getResponseCharset

public java.lang.String getResponseCharset()

Reports the character set from the Content-Type header. If no character set was specified then a default value of 'UTF-8' is returned.

Returns:

the character set from the Content-Type header.

getResponseFilename

public java.lang.String getResponseFilename()

Reports the filename from the Content-Disposition header.

Returns:

the filename from the Content-Disposition header.

writeResponse

public void writeResponse()
                   throws ApplicationException

Write the web service response to a file. The file type is is specified by the Content-Type header. The filename is specified by the Content-Disposition header and is located in the outbox directory specified by the client configuration properties file.

Throws:

ApplicationException - if an error occurs while writing the file.

getResponse

public java.lang.String getResponse()
                             throws ApplicationException

This method provides the web service response as a string. If the response was a zip file, the string value of the first zip entry is returned.

Returns:

the web service response string value.

Throws:

ApplicationException - if the response type was zip and the response could not be unzipped.