Skip navigation links


com.essbase.eas.net
Class CommandRequestor

java.lang.Object
  extended by com.essbase.eas.net.CommandRequestor


public class CommandRequestor
extends java.lang.Object

CommandRequestor: Primary class to make requests from a client to the olap administration server In the common package because occasionally an admin server needs to be a client of another admin server

Version:
1.0.0, 08/09/2000 Created 1.1.0, 08/30/2000 Added large data transfer
Author:
Brian Litofsky

Constructor Summary
CommandRequestor(java.lang.String server)
          Creates a command requestor pointing at the servlet as given
CommandRequestor(java.net.URL url)
          Creates a command requestor pointing at the servlet as given.

 

Method Summary
 boolean canSecureMessages()
           
 java.lang.Exception getException()
           
 boolean getSecureAllMessages()
           
 java.net.URL getServletURL()
          Gets the URL of the servlet that the commands are being posted to
 java.io.InputStream sendCommand(java.lang.String command)
          Action method to request a command without parameters
 java.io.InputStream sendCommand(java.lang.String command, boolean secure)
           
 java.io.InputStream sendCommand(java.lang.String command, java.util.Properties parameters)
           
 java.io.InputStream sendCommand(java.lang.String command, java.util.Properties parameters, boolean secure)
          Action method to request a command
 java.io.InputStream sendCommand(java.lang.String command, java.util.Properties parameters, byte[] data)
           
 java.io.InputStream sendCommand(java.lang.String command, java.util.Properties parameters, byte[] data, boolean secure)
          Action method to request a command This version sends a large amount of data to the server that the command should know to expect.
 java.lang.String sendCommandGetString(java.lang.String command)
          Action method to request a command without parameters If you are sure that the response will be a String, this function can be used as a shortcut
 java.lang.String sendCommandGetString(java.lang.String command, boolean secure)
           
 java.lang.String sendCommandGetString(java.lang.String command, java.util.Properties parameters)
           
 java.lang.String sendCommandGetString(java.lang.String command, java.util.Properties parameters, boolean secure)
          Action method to request a command If you are sure that the response will be a String, this function can be used as a shortcut
 java.lang.String sendCommandGetString(java.lang.String command, java.util.Properties parameters, byte[] data)
           
 java.lang.String sendCommandGetString(java.lang.String command, java.util.Properties parameters, byte[] data, boolean secure)
          Action method to request a command If you are sure that the response will be a String, this function can be used as a shortcut This version sends a large amount of data to the server that the command should know to expect.
 java.io.InputStream sendSecureCommand(java.lang.String command)
           
 java.io.InputStream sendSecureCommand(java.lang.String command, java.util.Properties parameters)
           
 java.io.InputStream sendSecureCommand(java.lang.String command, java.util.Properties parameters, byte[] data)
           
 java.lang.String sendSecureCommandGetString(java.lang.String command)
           
 java.lang.String sendSecureCommandGetString(java.lang.String command, java.util.Properties parameters)
           
 java.lang.String sendSecureCommandGetString(java.lang.String command, java.util.Properties parameters, byte[] data)
           
 void setSecureAllMessages(boolean secure)
          Sets the transport to secure all messages

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

CommandRequestor

public CommandRequestor(java.lang.String server)
                 throws java.net.MalformedURLException,
                        java.io.IOException,
                        java.util.MissingResourceException
Creates a command requestor pointing at the servlet as given
Parameters:
server - Server name, should be either "machinename", which will use the default port, or "machinename:portnumber" to use a different port.
Throws:
java.net.MalformedURLException
java.io.IOException
java.util.MissingResourceException

CommandRequestor

public CommandRequestor(java.net.URL url)
                 throws java.net.MalformedURLException,
                        java.io.IOException
Creates a command requestor pointing at the servlet as given. This overrides all defaults used by the other constructor.
Parameters:
URL - A fully defined URL to find the servlet
Throws:
java.net.MalformedURLException
java.io.IOException

Method Detail

getServletURL

public java.net.URL getServletURL()
Gets the URL of the servlet that the commands are being posted to

setSecureAllMessages

public void setSecureAllMessages(boolean secure)
Sets the transport to secure all messages

getSecureAllMessages

public boolean getSecureAllMessages()

canSecureMessages

public boolean canSecureMessages()

getException

public java.lang.Exception getException()

sendCommand

public java.io.InputStream sendCommand(java.lang.String command)
                                throws java.io.IOException
Action method to request a command without parameters
Throws:
java.io.IOException

sendSecureCommand

public java.io.InputStream sendSecureCommand(java.lang.String command)
                                      throws java.io.IOException
Throws:
java.io.IOException

sendCommand

public java.io.InputStream sendCommand(java.lang.String command,
                                       boolean secure)
                                throws java.io.IOException
Throws:
java.io.IOException

sendCommand

public java.io.InputStream sendCommand(java.lang.String command,
                                       java.util.Properties parameters)
                                throws java.io.IOException
Throws:
java.io.IOException

sendSecureCommand

public java.io.InputStream sendSecureCommand(java.lang.String command,
                                             java.util.Properties parameters)
                                      throws java.io.IOException
Throws:
java.io.IOException

sendCommand

public java.io.InputStream sendCommand(java.lang.String command,
                                       java.util.Properties parameters,
                                       boolean secure)
                                throws java.io.IOException
Action method to request a command
Throws:
java.io.IOException

sendSecureCommand

public java.io.InputStream sendSecureCommand(java.lang.String command,
                                             java.util.Properties parameters,
                                             byte[] data)
                                      throws java.io.IOException
Throws:
java.io.IOException

sendCommand

public java.io.InputStream sendCommand(java.lang.String command,
                                       java.util.Properties parameters,
                                       byte[] data)
                                throws java.io.IOException
Throws:
java.io.IOException

sendCommand

public java.io.InputStream sendCommand(java.lang.String command,
                                       java.util.Properties parameters,
                                       byte[] data,
                                       boolean secure)
                                throws java.io.IOException
Action method to request a command This version sends a large amount of data to the server that the command should know to expect.
Throws:
java.io.IOException

sendCommandGetString

public java.lang.String sendCommandGetString(java.lang.String command)
                                      throws java.io.IOException
Action method to request a command without parameters If you are sure that the response will be a String, this function can be used as a shortcut
Throws:
java.io.IOException

sendSecureCommandGetString

public java.lang.String sendSecureCommandGetString(java.lang.String command)
                                            throws java.io.IOException
Throws:
java.io.IOException

sendCommandGetString

public java.lang.String sendCommandGetString(java.lang.String command,
                                             boolean secure)
                                      throws java.io.IOException
Throws:
java.io.IOException

sendCommandGetString

public java.lang.String sendCommandGetString(java.lang.String command,
                                             java.util.Properties parameters)
                                      throws java.io.IOException
Throws:
java.io.IOException

sendSecureCommandGetString

public java.lang.String sendSecureCommandGetString(java.lang.String command,
                                                   java.util.Properties parameters)
                                            throws java.io.IOException
Throws:
java.io.IOException

sendCommandGetString

public java.lang.String sendCommandGetString(java.lang.String command,
                                             java.util.Properties parameters,
                                             boolean secure)
                                      throws java.io.IOException
Action method to request a command If you are sure that the response will be a String, this function can be used as a shortcut
Throws:
java.io.IOException

sendCommandGetString

public java.lang.String sendCommandGetString(java.lang.String command,
                                             java.util.Properties parameters,
                                             byte[] data)
                                      throws java.io.IOException
Throws:
java.io.IOException

sendSecureCommandGetString

public java.lang.String sendSecureCommandGetString(java.lang.String command,
                                                   java.util.Properties parameters,
                                                   byte[] data)
                                            throws java.io.IOException
Throws:
java.io.IOException

sendCommandGetString

public java.lang.String sendCommandGetString(java.lang.String command,
                                             java.util.Properties parameters,
                                             byte[] data,
                                             boolean secure)
                                      throws java.io.IOException
Action method to request a command If you are sure that the response will be a String, this function can be used as a shortcut This version sends a large amount of data to the server that the command should know to expect.
Throws:
java.io.IOException

Skip navigation links


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