Skip navigation links


com.essbase.eas.framework.defs.command
Interface CommandRequestor

All Known Implementing Classes:
DefaultCommandRequestor

public interface CommandRequestor

Provides the definition for classes that request commands be sent to a web-based server. In general, none of the methods in this interface should normally be called by user code. All commands should be routed through an instance of CommandRouter object.

Since:
7.0.0
Version:
7.1.0
Author:
Hank Cox

Method Summary
 boolean canSecureMessages()
          Return whether secure transport is successfully configured
 CommandString[] getCommandSet()
          retrieves the set of commands that this CommandRequestor object supports.
 int getDefaultPort()
          Get the default port for that a server would normally be found at.
 java.lang.Exception getException()
          When transport is not secure this will return the Exception that was the reason that transport can not be secure
 boolean getSecureAllMessages()
          Gets the secure all messages setting
 java.net.URL getServletURL()
          returns the servlet URL with which this CommandRequestor object is associated.
 java.io.InputStream sendCommand(java.lang.String command)
          sends a command to the servlet associated with this CommandRequestor object.
 java.io.InputStream sendCommand(java.lang.String command, boolean secure)
          sends a command to the servlet associated with this CommandRequestor object.
 java.io.InputStream sendCommand(java.lang.String command, java.util.Properties arguments)
          sends a command with a set of parameters to the servlet associated with this CommandRequestor object.
 java.io.InputStream sendCommand(java.lang.String command, java.util.Properties arguments, boolean secure)
          sends a command with a set of parameters to the servlet associated with this CommandRequestor object.
 java.io.InputStream sendCommand(java.lang.String command, java.util.Properties arguments, byte[] data)
          sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
 java.io.InputStream sendCommand(java.lang.String command, java.util.Properties arguments, byte[] data, boolean secure)
          sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
 java.io.InputStream sendCommand(java.lang.String command, java.util.Properties arguments, byte[] data, int offset, int len, boolean secure)
          sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
 java.lang.String sendCommandGetString(java.lang.String command)
          sends a command to the servlet associated with this CommandRequestor object.
 java.lang.String sendCommandGetString(java.lang.String command, boolean secure)
          sends a command to the servlet associated with this CommandRequestor object.
 java.lang.String sendCommandGetString(java.lang.String command, java.util.Properties arguments)
          sends a command with a set of parameters to the servlet associated with this CommandRequestor object.
 java.lang.String sendCommandGetString(java.lang.String command, java.util.Properties arguments, boolean secure)
          sends a command with a set of parameters to the servlet associated with this CommandRequestor object.
 java.lang.String sendCommandGetString(java.lang.String command, java.util.Properties arguments, byte[] data)
          sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
 java.lang.String sendCommandGetString(java.lang.String command, java.util.Properties arguments, byte[] data, boolean secure)
          sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
 java.lang.String sendCommandGetString(java.lang.String command, java.util.Properties arguments, byte[] data, int offset, int len, boolean secure)
          sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
 void setSecureAllMessages(boolean secure)
          Sets the transport to secure all commands sent by this CommandRequestor
 void setServletURL(java.net.URL value)
          sets the servlet URL with which this CommandRequestor object is associated.

 

Method Detail

getServletURL

java.net.URL getServletURL()
returns the servlet URL with which this CommandRequestor object is associated.
Returns:
the URL that this requestor will route command requests to.

setServletURL

void setServletURL(java.net.URL value)
                   throws java.lang.IllegalArgumentException,
                          java.io.IOException
sets the servlet URL with which this CommandRequestor object is associated.
Parameters:
value - the URL to route this requestor's commands to.
Throws:
java.lang.IllegalArgumentException - if the parameter is null.
java.io.IOException

getDefaultPort

int getDefaultPort()
Get the default port for that a server would normally be found at.
Returns:
- the port as an integer

setSecureAllMessages

void setSecureAllMessages(boolean secure)
Sets the transport to secure all commands sent by this CommandRequestor
Parameters:
secure - set to true to use secure transport for all commands

getSecureAllMessages

boolean getSecureAllMessages()
Gets the secure all messages setting
Returns:
value of secure all setting

canSecureMessages

boolean canSecureMessages()
Return whether secure transport is successfully configured
Returns:
true if secure transport is configured

getException

java.lang.Exception getException()
When transport is not secure this will return the Exception that was the reason that transport can not be secure
Returns:
the Exception that is the reason that transport is not secure

sendCommand

java.io.InputStream sendCommand(java.lang.String command)
                                throws java.io.IOException
sends a command to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
Returns:
an InputStream object containing the results.
Throws:
java.io.IOException

sendCommand

java.io.InputStream sendCommand(java.lang.String command,
                                boolean secure)
                                throws java.io.IOException
sends a command to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
secure - set to true to secure the command and it's results
Returns:
an InputStream object containing the results.
Throws:
java.io.IOException

sendCommand

java.io.InputStream sendCommand(java.lang.String command,
                                java.util.Properties arguments)
                                throws java.io.IOException
sends a command with a set of parameters to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
arguments - the map of argument names and values.
Returns:
an InputStream object containing the results.
Throws:
java.io.IOException

sendCommand

java.io.InputStream sendCommand(java.lang.String command,
                                java.util.Properties arguments,
                                boolean secure)
                                throws java.io.IOException
sends a command with a set of parameters to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
arguments - the map of argument names and values.
secure - set to true to secure the command and it's results
Returns:
an InputStream object containing the results.
Throws:
java.io.IOException

sendCommand

java.io.InputStream sendCommand(java.lang.String command,
                                java.util.Properties arguments,
                                byte[] data)
                                throws java.io.IOException
sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
arguments - the map of argument names and values.
data - a byte array containing the supplemental information to send.
Returns:
an InputStream object containing the results.
Throws:
java.io.IOException

sendCommand

java.io.InputStream sendCommand(java.lang.String command,
                                java.util.Properties arguments,
                                byte[] data,
                                boolean secure)
                                throws java.io.IOException
sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
arguments - the map of argument names and values.
data - a byte array containing the supplemental information to send.
secure - set to true to secure the command and it's results
Returns:
an InputStream object containing the results.
Throws:
java.io.IOException

sendCommand

java.io.InputStream sendCommand(java.lang.String command,
                                java.util.Properties arguments,
                                byte[] data,
                                int offset,
                                int len,
                                boolean secure)
                                throws java.io.IOException
sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
arguments - the map of argument names and values.
data - a byte array containing the supplemental information to send.
offset - offset of the data
len - length of data
secure - set to true to secure the command and it's results
Returns:
an InputStream object containing the results.
Throws:
java.io.IOException

sendCommandGetString

java.lang.String sendCommandGetString(java.lang.String command)
                                      throws java.io.IOException
sends a command to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
Returns:
an String object containing the results.
Throws:
java.io.IOException

sendCommandGetString

java.lang.String sendCommandGetString(java.lang.String command,
                                      boolean secure)
                                      throws java.io.IOException
sends a command to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
secure - set to true to secure the command and it's results
Returns:
an String object containing the results
Throws:
java.io.IOException

sendCommandGetString

java.lang.String sendCommandGetString(java.lang.String command,
                                      java.util.Properties arguments)
                                      throws java.io.IOException
sends a command with a set of parameters to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
arguments - the map of argument names and values.
Returns:
an String object containing the results.
Throws:
java.io.IOException

sendCommandGetString

java.lang.String sendCommandGetString(java.lang.String command,
                                      java.util.Properties arguments,
                                      boolean secure)
                                      throws java.io.IOException
sends a command with a set of parameters to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
arguments - the map of argument names and values.
secure - set to true to secure the command and it's results
Returns:
an String object containing the results.
Throws:
java.io.IOException

sendCommandGetString

java.lang.String sendCommandGetString(java.lang.String command,
                                      java.util.Properties arguments,
                                      byte[] data)
                                      throws java.io.IOException
sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
arguments - the map of argument names and values.
data - a byte array containing the supplemental information to send.
Returns:
an String object containing the results.
Throws:
java.io.IOException

sendCommandGetString

java.lang.String sendCommandGetString(java.lang.String command,
                                      java.util.Properties arguments,
                                      byte[] data,
                                      boolean secure)
                                      throws java.io.IOException
sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
arguments - the map of argument names and values.
data - a byte array containing the supplemental information to send.
secure - set to true to secure the command and it's results
Returns:
an String object containing the results.
Throws:
java.io.IOException

sendCommandGetString

java.lang.String sendCommandGetString(java.lang.String command,
                                      java.util.Properties arguments,
                                      byte[] data,
                                      int offset,
                                      int len,
                                      boolean secure)
                                      throws java.io.IOException
sends a command with arguments and an associated block of data to the servlet associated with this CommandRequestor object.
Parameters:
command - the command to route
arguments - the map of argument names and values.
data - a byte array containing the supplemental information to send.
offset - buffer offset
len - length of data
secure - set to true to secure the command and it's results
Returns:
an String object containing the results.
Throws:
java.io.IOException

getCommandSet

CommandString[] getCommandSet()
retrieves the set of commands that this CommandRequestor object supports. If an empty array is returned, then this CommandRequestor can be sent any command.
Returns:
the array of CommandString objects

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.