com.bea.wlpi.client.common
Class WLPI

java.lang.Object
  |
  +--com.bea.wlpi.client.common.WLPI

public final class WLPI

extends java.lang.Object

Provides a standard way to connect to a WebLogic Process Integrator server and access resources therein.

Field Summary

protected static java.lang.String

WEBLOGIC_REALM

Constructor Summary

WLPI()
Create a new WLPI object.

Method Summary

boolean	allowSecurityRealmUpdates() Check whether the installed security realm is both manageable and persistent.
boolean	connect(java.awt.Component parent, java.lang.String url, java.lang.String userId, java.lang.String password) Connect to WebLogic Process Integrator server using the specified parameters.
void	disconnect() Disconnect from WebLogic Process Integrator server.
Admin	getAdmin() Return a reference to an Admin EJB object.
EJBCatalog	getCatalog() Return a reference to an EJBCatalog EJB object.
WLPIPrincipal	getPrincipal() Return a reference to a WLPIPrincipal EJB object.
ServerProperties	getServerProperties() Return a reference to a ServerProperties EJB object.
VersionInfo	getServerTemplateDefinitionVersion() Return information about the server's template definition version.
VersionInfo	getServerVersion() Return information about the server version.
java.lang.String	getUrl() Return the WebLogic Process Integrator server URL.
java.lang.String	getUserId() Return the WebLogic Process Integrator user ID.
Worklist	getWorklist() Return a reference to a Worklist EJB object.
boolean	isConnected() Check whether this WLPI instance is connected to a server.

Methods inherited from class java.lang.Object

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

Field Detail

WEBLOGIC_REALM

protected static final java.lang.String WEBLOGIC_REALM

Constructor Detail

WLPI

public WLPI()

Create a new WLPI object.

Method Detail

allowSecurityRealmUpdates

public boolean allowSecurityRealmUpdates()

Check whether the installed security realm is both manageable and persistent. WebLogic Server's default 'WebLogic Properties' realm is manageable, but is not currently (version. 5.1) persistent.

Returns:

true If realm is both manageable and persistent.

Throws:

java.lang.IllegalStateException - if not connected.

connect

public boolean connect(java.awt.Component parent,
                       java.lang.String url,
                       java.lang.String userId,
                       java.lang.String password)

Connect to WebLogic Process Integrator server using the specified parameters.

Parameters:

parent - The parent component for dialogs and message boxes.

url - The WebLogic Process Integrator server URL.

userId - The WebLogic Process Integrator user's ID.

password - The user's password.

Throws:

java.lang.IllegalStateException - if already connected.

See Also:

disconnect()

disconnect

public void disconnect()

Disconnect from WebLogic Process Integrator server. Calls remove on all EJB session beans.

See Also:

connect(java.awt.Component, java.lang.String, java.lang.String, java.lang.String)

isConnected

public boolean isConnected()

Check whether this WLPI instance is connected to a server.

Returns:

true if connected.

getUrl

public java.lang.String getUrl()

Return the WebLogic Process Integrator server URL.

Returns:

The WebLogic Process Integrator server URL (null if not logged on).

getUserId

public java.lang.String getUserId()

Return the WebLogic Process Integrator user ID.

Returns:

The WebLogic Process Integrator user ID (null if not logged on).

getAdmin

public Admin getAdmin()
               throws WorkflowException

Return a reference to an Admin EJB object.

Returns:

A reference to an Admin EJB object.

Throws:

java.lang.IllegalStateException - if not connected.

WorkflowException - if an exception occurred.

See Also:

getCatalog(), getPrincipal(), getWorklist()

getCatalog

public EJBCatalog getCatalog()
                      throws WorkflowException

Return a reference to an EJBCatalog EJB object.

Returns:

A reference to an EJBCatalog EJB object.

Throws:

java.lang.IllegalStateException - if not connected.

WorkflowException - if an exception occurred.

See Also:

getAdmin(), getPrincipal(), getWorklist()

getPrincipal

public WLPIPrincipal getPrincipal()
                           throws WorkflowException

Return a reference to a WLPIPrincipal EJB object.

Returns:

A reference to a WLPIPrincipal EJB object.

Throws:

java.lang.IllegalStateException - if not connected.

See Also:

getAdmin(), getCatalog(), getWorklist()

getWorklist

public Worklist getWorklist()
                     throws WorkflowException

Return a reference to a Worklist EJB object.

Returns:

A reference to a Worklist EJB object.

Throws:

java.lang.IllegalStateException - if not connected.

WorkflowException - if an exception occurred.

See Also:

getAdmin(), getCatalog(), getPrincipal()

getServerProperties

public final ServerProperties getServerProperties()

Return a reference to a ServerProperties EJB object.

Returns:

A reference to a ServerProperties object.

Throws:

java.lang.IllegalStateException - if not connected.

See Also:

getAdmin(), getCatalog(), getPrincipal(), getServerVersion(), getServerTemplateDefinitionVersion()

getServerVersion

public VersionInfo getServerVersion()

Return information about the server version.

Returns:

version information.

Throws:

java.lang.IllegalStateException - if not connected.

See Also:

getAdmin(), getCatalog(), getPrincipal(), getServerProperties(), getServerTemplateDefinitionVersion()

getServerTemplateDefinitionVersion

public VersionInfo getServerTemplateDefinitionVersion()

Return information about the server's template definition version.

Returns:

version information.

Throws:

java.lang.IllegalStateException - if not connected.

See Also:

getAdmin(), getCatalog(), getPrincipal(), getServerProperties(), getServerVersion()