Skip navigation links

com.oracle.bpel.client
Class Server

java.lang.Object
com.oracle.bpel.client.Server

public final class Server

extends java.lang.Object

The Server class allows the user to perform administrative functions on a BPEL server.

Since:

2.0

Constructor Summary

Server()
Default constructor.

Server(ServerAuth auth)
Constructs a server object with an existing set of administrative authentication credentials.

Method Summary

void	changePassword(java.lang.String oldPassword, java.lang.String newPassword) Changes the administrative password for the BPEL server.
void	createDomain(java.lang.String domainId, java.lang.String password, java.util.Map domainProperties) Creates a BPEL process domain with the specified domain identifier and password.
void	deleteDomain(java.lang.String domainId, boolean keepData) Deletes a BPEL process domain.
BPELDomainStatus[]	getAllAccessibleDomainStatus() Returns the status for all the BPEL process domains deployed on the BPEL server, that are accessible to the current authenticated user.
BPELDomainStatus[]	getAllDomainStatus() Returns the status for all the BPEL process domains deployed on the BPEL server.
ServerDescriptor	getDescriptor() Returns the BPEL server descriptor.
BPELDomainStatus	getDomainStatus(java.lang.String domainId) Returns the status for a BPEL process domain.
ServerAuth	getServerAuth() Returns the server authentication credentials used to access the BPEL server.
com.oracle.bpel.client.config.XPathFunctionDescriptor	getXPathDescriptor()
boolean	isDomainAuthEnabled() Returns true if domain authentication has been enabled for the BPEL server.
boolean	isDomainListingEnabled() Returns true if domain listing has been enabled for the BPEL server.
boolean	isProductionServer() Returns true if the server is in Production mode.
java.util.Map	listLoggers() Returns a list of all the loggers defined for the server.
void	setServerAuth(ServerAuth auth) Sets the administrative authentication credentials used to gain access to the BPEL server.
void	updateDescriptor(ServerDescriptor desc) Updates the server descriptor of the BPEL server with the values contained in the passed descriptor.
void	updateLoggers(java.util.Map levels) Updates the loggers defined for the BPEL server with the specified logging levels.

Methods inherited from class java.lang.Object

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

Constructor Detail

Server

public Server()

Default constructor.

Server

public Server(ServerAuth auth)

Constructs a server object with an existing set of administrative authentication credentials.

Parameters:

auth - administrative authentication credentials for the server

Method Detail

getServerAuth

public ServerAuth getServerAuth()

Returns the server authentication credentials used to access the BPEL server.

setServerAuth

public void setServerAuth(ServerAuth auth)

Sets the administrative authentication credentials used to gain access to the BPEL server.

getDescriptor

public ServerDescriptor getDescriptor()
                               throws ServerException

Returns the BPEL server descriptor. The server descriptor contains run-time configuration properties such as endpoint URLs and authentication settings.

Throws:

ServerException - if there is a problem connecting to the server.

updateDescriptor

public void updateDescriptor(ServerDescriptor desc)
                      throws ServerException

Updates the server descriptor of the BPEL server with the values contained in the passed descriptor.

Throws:

ServerException - if there is a problem connecting to the server or if there is a problem updating the server descriptor.

getXPathDescriptor

public com.oracle.bpel.client.config.XPathFunctionDescriptor getXPathDescriptor()
                                                                         throws ServerException

Throws:

ServerException

listLoggers

public java.util.Map listLoggers()
                          throws ServerException

Returns a list of all the loggers defined for the server. Currently, the BPEL server uses log4j to log error/debug/informational messages. This method will return a list of all the log4j logger names that have been defined for the server.

Please note that the BPEL server has a set of loggers separate from the domain loggers.

Returns:

a Map with the logger name as the key and the current logger level as a String.

Throws:

ServerException - if there is a problem connecting to the server.

updateLoggers

public void updateLoggers(java.util.Map levels)
                   throws ServerException

Updates the loggers defined for the BPEL server with the specified logging levels. Currently, the BPEL server uses log4j to log error/debug/informational messages. The logging levels recognized by the domain are:

• OFF - highest possible rank, intended to turn off logging.
• FATAL - very severe error events that will presumably lead the process/instance to abort.
• ERROR - error events that might still allow the process/instance to continue running.
• WARN - potentially harmful situations.
• INFO - informational messages that highlight the progress of the process/instance at coarse-grained level.
• DEBUG - fine-grained informational events, most useful to debug server internals.
  ALL - lowest possible rank, intended to turn on all logging.

  Please note that the BPEL server has a set of loggers separate from the domain loggers.

  Parameters:

  levels - Map with the logger name as the key and the desired logger level as a String.

  Throws:

  ServerException - if there is a problem connecting to the server or if there is problem updating the loggers defined for the server.

  changePassword

  public void changePassword(java.lang.String oldPassword,
                             java.lang.String newPassword)
                      throws ServerException
  

  Changes the administrative password for the BPEL server. The existing administrative password must be supplied as a security precaution.

  Parameters:

  oldPassword - the existing administrative password

  newPassword - the new administrative password

  Throws:

  ServerException - if there is a problem connecting to the server or if the old password supplied is incorrect.

  getDomainStatus

  public BPELDomainStatus getDomainStatus(java.lang.String domainId)
                                   throws ServerException
  

  Returns the status for a BPEL process domain.

  Parameters:

  domainId - the BPEL process domain identifier

  Throws:

  ServerException - if there is a problem connecting to the server or if the specified domain cannot be found.

  getAllAccessibleDomainStatus

  public BPELDomainStatus[] getAllAccessibleDomainStatus()
                                                  throws ServerException
  

  Returns the status for all the BPEL process domains deployed on the BPEL server, that are accessible to the current authenticated user.

  Throws:

  ServerException - if there is a problem connecting to the server.

  getAllDomainStatus

  public BPELDomainStatus[] getAllDomainStatus()
                                        throws ServerException
  

  Returns the status for all the BPEL process domains deployed on the BPEL server.

  Throws:

  ServerException - if there is a problem connecting to the server.

  createDomain

  public void createDomain(java.lang.String domainId,
                           java.lang.String password,
                           java.util.Map domainProperties)
                    throws ServerException
  

  Creates a BPEL process domain with the specified domain identifier and password. The new domain will be created at obHome /domains/ domainId where obHome is the installation directory for the BPEL server.

  Domain identifiers are limited to 50 characters and must conform to the following format:

  • the initial character may be a letter, a currency symbol (such as '$') or a connecting punctation character (such as '_').
  • the remaining characters may be a letter, a currency symbol (such as '$'), a connection punctuation character (such as '_' or '-') or a digit.

  If no password is desired for the domain, use null for the password.

  Parameters:

  domainId - the BPEL process domain identifier

  password - the password for the new BPEL process domain

  Throws:

  ServerException - either one of the following errors:

  • problem connecting to the server,
  • a domain with the specified identifier already exists,
  • invalid domain identifier encountered,
  • problems writing to the domain directory.

  deleteDomain

  public void deleteDomain(java.lang.String domainId,
                           boolean keepData)
                    throws ServerException
  

  Deletes a BPEL process domain.

  In order to preserve deployed processes and data logs associated with the domain, pass true for the keepData parameter. In this case, the old domain directory will be copied to obHome /domains/.deleted/ domainId where obHome is the installation directory for the BPEL server.

  All instances and activities associated with the BPEL process domain will be deleted from the domain datastore.

  Parameters:

  domainId - the BPEL process domain identifier

  keepData - set to true if domain directory contents are to be preserved.

  Throws:

  ServerException - either one of the following errors:

  • problem connecting to the server,
  • a domain with the specified identifier cannot be found,
  • problems deleting the data from the domain datastore.

  isDomainAuthEnabled

  public boolean isDomainAuthEnabled()
                              throws ServerException
  

  Returns true if domain authentication has been enabled for the BPEL server. If domain authentication is enabled, users will be required to authenticate with a domain before accessing any instances and activities associated with it.

  This property is set upon startup from the value contained in the BPEL server configuration file collaxa-config.xml located in the obHome /system/config directory (where obHome is the installation directory for the BPEL server).

   <property name="domain_auth_enabled">false</property>
   
  

  Throws:

  ServerException - if there is a problem connecting to the server.

  isDomainListingEnabled

  public boolean isDomainListingEnabled()
                                 throws ServerException
  

  Returns true if domain listing has been enabled for the BPEL server. If domain listing is enabled, console users will see a select drop-down containing a list of all the domain deployed to the BPEL server. If domain listing is disabled, console users will be required to enter the domain they wish to authenticate to.

  On installation where the presence of a domain must be kept hidden from users of another domain domain listing may be disabled.

  This property is set upon startup from the value contained in the BPEL server configuration file collaxa-config.xml located in the obHome /system/config directory (where obHome is the installation directory for the BPEL server).

   <property name="domain_listing_enabled">true</property>
   
  

  Throws:

  ServerException - if there is a problem connecting to the server.

  isProductionServer

  public boolean isProductionServer()
                             throws ServerException
  

  Returns true if the server is in Production mode. UI will be more restrictive on what deployment options are allowed when deploying to a server in production mode. The property is set upon startup from the value contained in the BPEL server configuration file collaxa-config.xml located in the obHome /system/config directory (where obHome is the installation directory for the BPEL server).

  Throws:

  ServerException - if there is a problem connecting to the server.