com.businesslink.sgi.api.hsm
Class HsmServerRequest

java.lang.Object
  |
  +--com.businesslink.sgi.api.hsm.HsmServerRequest

public final class HsmServerRequest
extends java.lang.Object

A wrapper of HsmData objects; used by a HSM server to get client request data and set server reply data. Refer to the HsmData class for get/set method documentation.

See Also:
HsmData

Method Summary
 HsmData copyOfReply()
          Returns a copy of the internal reply object.
 HsmData copyOfRequest()
          Returns a copy of the internal request object.
 void dumpReply(java.io.PrintWriter writer)
          Displays the contents of the internal reply object to the specified PrintWriter.
 void dumpRequest(java.io.PrintWriter writer)
          Displays the contents of the internal request object to the specified PrintWriter.
 int getReplyPosition()
           
 int getReplyUnused()
           
 char[] getRequestChars()
           
 char[] getRequestChars(int start)
           
 char[] getRequestChars(int start, int length)
           
 char[] getRequestCharsNext()
           
 char[] getRequestCharsNext(int length)
           
 int getRequestLength()
           
 java.lang.String getRequestOpcode()
           
 int getRequestPosition()
           
 int getRequestRemaining()
           
 java.lang.String getRequestString()
           
 java.lang.String getRequestString(int start)
           
 java.lang.String getRequestString(int start, int length)
           
 java.lang.StringBuffer getRequestStringBuffer()
           
 java.lang.StringBuffer getRequestStringBuffer(int start)
           
 java.lang.StringBuffer getRequestStringBuffer(int start, int length)
           
 java.lang.StringBuffer getRequestStringBufferNext()
           
 java.lang.StringBuffer getRequestStringBufferNext(int length)
           
 java.lang.String getRequestStringNext()
           
 java.lang.String getRequestStringNext(int length)
           
 int getRequestTimeout()
          Returns the number of seconds the HSM server will wait for a request before timing out.
 void resetReply()
           
 void setReplyData(char[] data)
           
 void setReplyData(int start, char[] data)
           
 void setReplyData(int start, int length, char[] data)
           
 void setReplyData(int start, int length, java.lang.String data)
           
 void setReplyData(int start, int length, java.lang.StringBuffer data)
           
 void setReplyData(int start, java.lang.String data)
           
 void setReplyData(int start, java.lang.StringBuffer data)
           
 void setReplyData(java.lang.String data)
           
 void setReplyData(java.lang.StringBuffer data)
           
 void setReplyDataNext(char[] data)
           
 void setReplyDataNext(int length, char[] data)
           
 void setReplyDataNext(int length, java.lang.String data)
           
 void setReplyDataNext(int length, java.lang.StringBuffer data)
           
 void setReplyDataNext(java.lang.String data)
           
 void setReplyDataNext(java.lang.StringBuffer data)
           
 void setReplyOpcode(java.lang.String opcode)
           
 void setReplyPosition(int position)
           
 void setRequestPosition(int position)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getRequestOpcode

public java.lang.String getRequestOpcode()

getRequestLength

public int getRequestLength()

getRequestRemaining

public int getRequestRemaining()

getRequestPosition

public int getRequestPosition()

setRequestPosition

public void setRequestPosition(int position)

getRequestTimeout

public int getRequestTimeout()
Returns the number of seconds the HSM server will wait for a request before timing out. A value of -1 indicates that the server will wait indefinitely.
Returns:
number of seconds the server will wait.

copyOfRequest

public HsmData copyOfRequest()
Returns a copy of the internal request object.
Returns:
request HsmData object.

dumpRequest

public void dumpRequest(java.io.PrintWriter writer)
Displays the contents of the internal request object to the specified PrintWriter.
Parameters:
writer - the PrintWriter to write to.

getRequestChars

public char[] getRequestChars()

getRequestChars

public char[] getRequestChars(int start)

getRequestChars

public char[] getRequestChars(int start,
                              int length)

getRequestCharsNext

public char[] getRequestCharsNext()

getRequestCharsNext

public char[] getRequestCharsNext(int length)

getRequestString

public java.lang.String getRequestString()

getRequestString

public java.lang.String getRequestString(int start)

getRequestString

public java.lang.String getRequestString(int start,
                                         int length)

getRequestStringNext

public java.lang.String getRequestStringNext()

getRequestStringNext

public java.lang.String getRequestStringNext(int length)

getRequestStringBuffer

public java.lang.StringBuffer getRequestStringBuffer()

getRequestStringBuffer

public java.lang.StringBuffer getRequestStringBuffer(int start)

getRequestStringBuffer

public java.lang.StringBuffer getRequestStringBuffer(int start,
                                                     int length)

getRequestStringBufferNext

public java.lang.StringBuffer getRequestStringBufferNext()

getRequestStringBufferNext

public java.lang.StringBuffer getRequestStringBufferNext(int length)

setReplyOpcode

public void setReplyOpcode(java.lang.String opcode)

getReplyUnused

public int getReplyUnused()

getReplyPosition

public int getReplyPosition()

setReplyPosition

public void setReplyPosition(int position)

resetReply

public void resetReply()

copyOfReply

public HsmData copyOfReply()
Returns a copy of the internal reply object.
Returns:
reply HsmData object.

dumpReply

public void dumpReply(java.io.PrintWriter writer)
Displays the contents of the internal reply object to the specified PrintWriter.
Parameters:
writer - the PrintWriter to write to.

setReplyData

public void setReplyData(char[] data)

setReplyData

public void setReplyData(java.lang.String data)

setReplyData

public void setReplyData(java.lang.StringBuffer data)

setReplyData

public void setReplyData(int start,
                         char[] data)

setReplyData

public void setReplyData(int start,
                         java.lang.String data)

setReplyData

public void setReplyData(int start,
                         java.lang.StringBuffer data)

setReplyData

public void setReplyData(int start,
                         int length,
                         char[] data)

setReplyData

public void setReplyData(int start,
                         int length,
                         java.lang.String data)

setReplyData

public void setReplyData(int start,
                         int length,
                         java.lang.StringBuffer data)

setReplyDataNext

public void setReplyDataNext(char[] data)

setReplyDataNext

public void setReplyDataNext(java.lang.String data)

setReplyDataNext

public void setReplyDataNext(java.lang.StringBuffer data)

setReplyDataNext

public void setReplyDataNext(int length,
                             char[] data)

setReplyDataNext

public void setReplyDataNext(int length,
                             java.lang.String data)

setReplyDataNext

public void setReplyDataNext(int length,
                             java.lang.StringBuffer data)