com.mobileapps.pcre
Class PCREConfigServer

java.lang.Object
  |
  +--com.mobileapps.pcre.PCREService
        |
        +--com.mobileapps.pcre.PCREConfigServer
public class PCREConfigServer
extends PCREService

This class allows you to retrieve configuration information about the PCRE Server configuration. The information available from this class may be usefull to users who want to write portable applications, without having to hardcode hostnames, etc.

Constructor Summary
PCREConfigServer()
          Specify a PCRE Configuration Service without host or server name.
PCREConfigServer(java.lang.String host)
          Specify a PCRE Configuration Service with the given host and no server name.
PCREConfigServer(java.lang.String host, java.lang.String name)
          Specify a PCRE Configuration Service with the given host and server name.
 
Method Summary
 void Connect()
          Connect the client to the PCRE Configuration Server.
 void Disconnect()
          Disconnect the client from the PCRE Configuration Server.
 java.lang.String getHost()
          Return the host-name of the PCRE Configuration Server.
 java.lang.String getPCREDORTempDir()
          Get the temp directory on the server for DOR run-time temp files.
 java.lang.String getPCREFileServer()
          Return the name of the file transfer protocol used by the file return.
 java.lang.String getPCREGatewayName()
          Get the default PCREGateway name.
 java.lang.String getPCREHostAddress()
          Get the IP Address of the host on which the PCRE Product is installed.
 java.lang.String getPCREHostName()
          Get the name of the host on which the PCRE Product is installed.
 PCREInfo getPCREInfo()
          Retrieve all the attribute strings in one API call.
 java.lang.String getPCREInstallDir()
          Get the product installation directory, (this is the server side install directory).
 java.lang.String getPCREOutputDir()
          Get the name of the directory where output may be put.
 java.lang.String getPCRESampleOutputDir()
          Get the name of the directory to be used for sample output.
 java.lang.String getPCRESampleReportDir()
          Get the name of the directory containing the sample reports that ship with the product.
 java.lang.String getPCREVersion()
          Find the PCRE Product version.
 java.lang.String getPCREWebServerDir()
          Get the web server directory.
 void setHost(java.lang.String address)
          Set the host-name of the PCRE Configuration Server.
 
Methods inherited from class com.mobileapps.pcre.PCREService
getServerHost, getServerName, getServerObject, getServiceClient, getServiceName, isConnected, setConnected, setServerHost, setServerName, setServerObject, setServiceClient, setServiceName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PCREConfigServer

public PCREConfigServer()
Specify a PCRE Configuration Service without host or server name.

PCREConfigServer

public PCREConfigServer(java.lang.String host)
Specify a PCRE Configuration Service with the given host and no server name.
Parameters:
host - The host running the Gateway server.

PCREConfigServer

public PCREConfigServer(java.lang.String host,
                        java.lang.String name)
Specify a PCRE Configuration Service with the given host and server name.
Parameters:
host - The host running the Gateway server.
name - The name of the Gateway server.
Method Detail

Connect

public void Connect()
             throws PCREClientError
Connect the client to the PCRE Configuration Server. Must have connected client before making this call.
Throws:
PCREClientError - If the PCREConfigServer is not installed on the client, or on error
Overrides:
Connect in class PCREService

Disconnect

public void Disconnect()
Disconnect the client from the PCRE Configuration Server.
Overrides:
Disconnect in class PCREService

getHost

public java.lang.String getHost()
Return the host-name of the PCRE Configuration Server.
Returns:
The hostname on which the PCRE Configuration Server is running.

getPCREDORTempDir

public java.lang.String getPCREDORTempDir()
                                   throws PCREClientError
Get the temp directory on the server for DOR run-time temp files.
Returns:
The DOR run-time temp directory.

getPCREFileServer

public java.lang.String getPCREFileServer()
                                   throws PCREClientError
Return the name of the file transfer protocol used by the file return.
Returns:
The name of the file transfer protocol, currently on FTPServer is provided.

getPCREGatewayName

public java.lang.String getPCREGatewayName()
                                    throws PCREClientError
Get the default PCREGateway name.
Returns:
The default PCREGateway name.

getPCREHostAddress

public java.lang.String getPCREHostAddress()
                                    throws PCREClientError
Get the IP Address of the host on which the PCRE Product is installed.
Returns:
The ip address of the PCRE server.

getPCREHostName

public java.lang.String getPCREHostName()
                                 throws PCREClientError
Get the name of the host on which the PCRE Product is installed.
Returns:
The hostname of the PCRE Server.

getPCREInfo

public PCREInfo getPCREInfo()
                     throws PCREClientError,
                            PCREServerError
Retrieve all the attribute strings in one API call.
Returns:
All the attribute strings.

getPCREInstallDir

public java.lang.String getPCREInstallDir()
                                   throws PCREClientError
Get the product installation directory, (this is the server side install directory).
Returns:
The product installation directory.

getPCREOutputDir

public java.lang.String getPCREOutputDir()
                                  throws PCREClientError
Get the name of the directory where output may be put.
Returns:
The PCRE Output Directory.

getPCRESampleOutputDir

public java.lang.String getPCRESampleOutputDir()
                                        throws PCREClientError
Get the name of the directory to be used for sample output.
Returns:
The name of the output directory the sample programs will use.

getPCRESampleReportDir

public java.lang.String getPCRESampleReportDir()
                                        throws PCREClientError
Get the name of the directory containing the sample reports that ship with the product.
Returns:
The name of the directory containing the sample reports.

getPCREVersion

public java.lang.String getPCREVersion()
                                throws PCREClientError
Find the PCRE Product version.
Returns:
The PCRE Product version.

getPCREWebServerDir

public java.lang.String getPCREWebServerDir()
                                     throws PCREClientError
Get the web server directory.
Returns:
The web server directory.

setHost

public void setHost(java.lang.String address)
             throws PCREClientError
Set the host-name of the PCRE Configuration Server.
Parameters:
address - The host-name to use.