Skip navigation links

com.oracle.bpel.client.auth
Class ServerAuthFactory

java.lang.Object
com.oracle.bpel.client.auth.ServerAuthFactory

public final class ServerAuthFactory

extends java.lang.Object

Factory class for server authenticators.

Since:

2.0

Constructor Summary

ServerAuthFactory()

Method Summary

static ServerAuth	authenticate(java.lang.String password, java.lang.String ipAddress) Authenticates with the BPEL server using the administrative password specified by password.
static ServerAuth	authenticate(java.lang.String password, java.lang.String ipAddress, java.util.Hashtable contextProps) Authenticates with the BPEL server using the administrative password specified by password.
static void	validate(boolean logError, ServerAuth auth) Validates a set of server authentication credentials.
static void	validate(boolean logError, ServerAuth auth, java.util.Hashtable contextProps) Performs the same action as validate( boolean, ServerAuth ) but allows the user to pass in context properties that will be used to connect to a remote J2EE application in cases where the BPEL server is not located locally.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerAuthFactory

public ServerAuthFactory()

Method Detail

authenticate

public static ServerAuth authenticate(java.lang.String password,
                                      java.lang.String ipAddress)
                               throws ServerException

Authenticates with the BPEL server using the administrative password specified by password. An optional client IP address may be passed in; this information will be used to log failed attempts to authenticate with the BPEL server.

Parameters:

password - the administrative password for the BPEL server

ipAddress - IP address of the calling client (optional)

Throws:

ServerException - if cannot authenticate to the server using the specified password.

authenticate

public static ServerAuth authenticate(java.lang.String password,
                                      java.lang.String ipAddress,
                                      java.util.Hashtable contextProps)
                               throws ServerException

Authenticates with the BPEL server using the administrative password specified by password. An optional client IP address may be passed in; this information will be used to log failed attempts to authenticate with the BPEL process domain.

This constructor allows users to pass in context properties that will be used to connect to a remote J2EE application in cases where the BPEL server is not located locally.

Parameters:

password - the administrative password for the BPEL server

ipAddress - IP address of the calling client (optional)

contextProps - the initial context properties to use to connect to a remote J2EE application server where the BPEL server is hosted

Throws:

ServerException - if cannot authenticate to the server using the specified password or if unable to connect to the remote J2EE application server with the specified context properties.

validate

public static void validate(boolean logError,
                            ServerAuth auth)
                     throws ServerException

Validates a set of server authentication credentials. This method allows users to test whether a server authenticator can gain access to a BPEL server without executing a regular request.

Parameters:

logError - set to true if an authentication failure should be logged; false if logging should be suppressed.

auth - authentication credentials for the BPEL server

Throws:

ServerException - if cannot authenticate to the server using the specified password.

validate

public static void validate(boolean logError,
                            ServerAuth auth,
                            java.util.Hashtable contextProps)
                     throws ServerException

Performs the same action as validate( boolean, ServerAuth ) but allows the user to pass in context properties that will be used to connect to a remote J2EE application in cases where the BPEL server is not located locally.

Parameters:

logError - set to true if an authentication failure should be logged; false if logging should be suppressed.

auth - authentication credentials for the BPEL server

contextProps - the initial context properties to use to connect to a remote J2EE application server where the BPEL server is hosted

Throws:

ServerException - if cannot authenticate to the server using the specified password or if unable to connect to the remote J2EE application server with the specified context properties.

Skip navigation links