|
Oracle BPEL Process Manager Client API Reference 10g Release 2 (10.1.2) B25709-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.oracle.bpel.client.Server
The Server
class allows the user to perform administrative functions on a BPEL server.
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[] |
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. |
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 |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Server()
public Server(ServerAuth auth)
auth
- administrative authentication credentials for the serverMethod Detail |
public ServerAuth getServerAuth()
public void setServerAuth(ServerAuth auth)
public ServerDescriptor getDescriptor() throws ServerException
ServerException
- if there is a problem connecting to the server.public void updateDescriptor(ServerDescriptor desc) throws ServerException
ServerException
- if there is a problem connecting to the server or if there is a problem updating the server descriptor.public java.util.Map listLoggers() throws ServerException
Please note that the BPEL server has a set of loggers separate from the domain loggers.
Map
with the logger name as the key and the current logger level as a String
.ServerException
- if there is a problem connecting to the server.public void updateLoggers(java.util.Map levels) throws ServerException
Please note that the BPEL server has a set of loggers separate from the domain loggers.
levels
- Map
with the logger name as the key and the desired logger level as a String
.ServerException
- if there is a problem connecting to the server or if there is problem updating the loggers defined for the server.public void changePassword(java.lang.String oldPassword, java.lang.String newPassword) throws ServerException
oldPassword
- the existing administrative passwordnewPassword
- the new administrative passwordServerException
- if there is a problem connecting to the server or if the old password supplied is incorrect.public BPELDomainStatus getDomainStatus(java.lang.String domainId) throws ServerException
domainId
- the BPEL process domain identifierServerException
- if there is a problem connecting to the server or if the specified domain cannot be found.public BPELDomainStatus[] getAllDomainStatus() throws ServerException
ServerException
- if there is a problem connecting to the server.public void createDomain(java.lang.String domainId, java.lang.String password, java.util.Map domainProperties) throws ServerException
Domain identifiers are limited to 50 characters and must conform to the following format:
If no password is desired for the domain, use null
for the password.
domainId
- the BPEL process domain identifierpassword
- the password for the new BPEL process domainServerException
- either one of the following errors:
public void deleteDomain(java.lang.String domainId, boolean keepData) throws ServerException
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.
domainId
- the BPEL process domain identifierkeepData
- set to true
if domain directory contents are to be preserved.ServerException
- either one of the following errors:
public boolean isDomainAuthEnabled() throws ServerException
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>
ServerException
- if there is a problem connecting to the server.public boolean isDomainListingEnabled() throws ServerException
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>
ServerException
- if there is a problem connecting to the server.public boolean isProductionServer() throws ServerException
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).ServerException
- if there is a problem connecting to the server.
|
Oracle BPEL Process Manager Client API Reference 10g Release 2 (10.1.2) B25709-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |