com.aemo.msats.ws

Class C4

java.lang.Object

com.aemo.msats.ws.C4

public class C4
extends java.lang.Object

This class provides a wrapper method for each variant of the C4 web service.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	doC4(java.lang.String dataFilename, java.lang.String requestContentType) Make a request to the C4 web service by POSTing an aseXML file from the inbox.
java.lang.String	doC4(java.lang.String transactionId, java.lang.String NMI, java.lang.String fromDate, java.lang.String toDate, java.lang.String asatDate, java.lang.String participantId, java.lang.String roleId, java.lang.String inittransId) Make a GET request to the C4 web service.
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

C4

public C4()
   throws ApplicationException

Construct an instance of this class.

Throws:

ApplicationException - if the instance cannot be initialised.

Method Detail

doC4

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

Make a request to the C4 web service by POSTing an aseXML file from the inbox. The file should contain a single, valid ReportRequest 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.

doC4

public java.lang.String doC4(java.lang.String transactionId,
                    java.lang.String NMI,
                    java.lang.String fromDate,
                    java.lang.String toDate,
                    java.lang.String asatDate,
                    java.lang.String participantId,
                    java.lang.String roleId,
                    java.lang.String inittransId)
                      throws ApplicationException

Make a GET request to the C4 web service.

Parameters:

transactionId - identifies requestor's transaction.

NMI - identifies which NMI to fetch C4 NMI Master standing data for

fromDate - is the start date of the period you are interested in

toDate - is the end date of the period you are interested in

asatDate - is the date at which the records must have been active

participantId - is the participant you want shown as the filtering participant

roleId - is the role you want shown as the filtering role

inittransId - is the transaction Id that you want to track this request by

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.