org.dlese.dpc.ndr.connection

Class NDRConnection

java.lang.Object

org.dlese.dpc.ndr.connection.NDRConnection

public class NDRConnection
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NDRConnection()
	NDRConnection(java.lang.String _serviceURI)
	NDRConnection(java.lang.String _serviceURI, boolean _sslFlag)

Method Summary

Modifier and Type	Method and Description
NDRAPIProxy	connect() Connect via this NDR connection.
java.lang.String	getAgentHandle() Get the NDR agentHandle for this connection object.
java.lang.String	getCanonicalHeader() Get the canonical header for this connection object.
java.lang.String	getConnection() Retrieve the URL for this connection.
java.lang.String	getContent()
java.lang.String	getHeaderValue(java.lang.String key) Get a header value for the given key.
java.io.File	getKeyFile()
java.lang.Exception	getLastError()
java.security.PrivateKey	getPrivateKeyObject() Get the private key for this connection.
java.lang.String	getServer() Get the server for this object.
java.lang.String	getSignedHeader() Get the signed header ( canonical + x-nsdl-auth ).
boolean	isConnectionOK() Determine if the server for this connection is responding and operational.
java.lang.String	request()
java.lang.String	request(java.lang.String _content)
java.lang.String	requestGET(java.lang.String _content)
java.lang.String	requestGET(java.lang.String _content, boolean _withParameters)
void	setAgentHandle(java.lang.String _handle) Set the NDR connection agentHandle for this object.
void	setCanonicalHeader(boolean signed) Set the NDR specified canonical header for this connection.
void	setConnection(java.lang.String _url) Set the connection for this object give a url.
void	setContent(java.lang.String _requestContent)
void	setKeyFile(java.io.File f)
void	setServer(java.lang.String _server) Set the server for this object.
void	setTimeout(int millisecs)

Methods inherited from class java.lang.Object

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

Constructor Detail

NDRConnection

protected NDRConnection()
                 throws java.lang.Exception

Throws:

java.lang.Exception

NDRConnection

public NDRConnection(java.lang.String _serviceURI)
              throws java.lang.Exception

Throws:

java.lang.Exception

NDRConnection

public NDRConnection(java.lang.String _serviceURI,
                     boolean _sslFlag)
              throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getKeyFile

public java.io.File getKeyFile()

setKeyFile

public void setKeyFile(java.io.File f)

getServer

public java.lang.String getServer()

Get the server for this object.

Returns:

- the server for this object

setServer

public void setServer(java.lang.String _server)

Set the server for this object.

Parameters:

_server - - the server

getAgentHandle

public java.lang.String getAgentHandle()

Get the NDR agentHandle for this connection object.

Returns:

- the agent handle for this object.=

setAgentHandle

public void setAgentHandle(java.lang.String _handle)

Set the NDR connection agentHandle for this object.

Parameters:

_handle -

getLastError

public java.lang.Exception getLastError()

Returns:

isConnectionOK

public boolean isConnectionOK()

Determine if the server for this connection is responding and operational.

Returns:

- true if the connection is OK

getPrivateKeyObject

public java.security.PrivateKey getPrivateKeyObject()

Get the private key for this connection.

Returns:

- the PrivateKey object for this connection.

getConnection

public java.lang.String getConnection()

Retrieve the URL for this connection.

Returns:

- the URL string for this connection

setConnection

public void setConnection(java.lang.String _url)

Set the connection for this object give a url.

Parameters:

url -

setTimeout

public void setTimeout(int millisecs)

connect

public NDRAPIProxy connect()

Connect via this NDR connection.

setCanonicalHeader

public void setCanonicalHeader(boolean signed)

Set the NDR specified canonical header for this connection. This will sign the object with the appropriate x-nsdl-auth property as required by the NDR API specification http://ndr.comm.nsdl.com.

Parameters:

signed - - set the canonical x-ndsl-auth property or not

getCanonicalHeader

public java.lang.String getCanonicalHeader()

Get the canonical header for this connection object.

Returns:

- the canonical header

getSignedHeader

public java.lang.String getSignedHeader()

Get the signed header ( canonical + x-nsdl-auth ).

Returns:

- the signed header

getHeaderValue

public java.lang.String getHeaderValue(java.lang.String key)

Get a header value for the given key.

Parameters:

key - - the key of interest

Returns:

- the value for that key

setContent

public void setContent(java.lang.String _requestContent)

getContent

public java.lang.String getContent()

requestGET

public java.lang.String requestGET(java.lang.String _content)

requestGET

public java.lang.String requestGET(java.lang.String _content,
                                   boolean _withParameters)

request

public java.lang.String request()
                         throws java.lang.Exception

Throws:

java.lang.Exception

request

public java.lang.String request(java.lang.String _content)
                         throws java.lang.Exception

Throws:

java.lang.Exception