Skip navigation links

com.oracle.bpel.client.auth
Class DomainAuthFactory

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

public final class DomainAuthFactory

extends java.lang.Object

Factory class for domain authenticators.

Since:

2.0

Constructor Summary

DomainAuthFactory()

Method Summary

static DomainAuth	authenticate(java.lang.String domainId, java.lang.String password, java.lang.String ipAddress) Authenticates with the specified BPEL process domain using the domain password specified by password.
static DomainAuth	authenticate(java.lang.String domainId, java.lang.String password, java.lang.String ipAddress, java.util.Hashtable contextProps) Authenticates with the specified BPEL process domain using the domain password specified by password.
static void	validate(boolean logError, DomainAuth auth) Validates a set of domain authentication credentials.
static void	validate(boolean logError, DomainAuth auth, java.util.Hashtable contextProps) Performs the same action as validate( boolean, DomainAuth ) 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 process domain is not located locally.

Methods inherited from class java.lang.Object

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

Constructor Detail

DomainAuthFactory

public DomainAuthFactory()

Method Detail

authenticate

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

Authenticates with the specified BPEL process domain using the domain 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.

Parameters:

domainId - the BPEL process domain identifier

password - the password for the BPEL process domain

ipAddress - IP address of the calling client (optional)

Throws:

ServerException - if cannot authenticate to the domain using the specified password, or if no such domain exists with the specified domain identifier.

authenticate

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

Authenticates with the specified BPEL process domain using the domain 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 process domain is not located locally.

Parameters:

domainId - the BPEL process domain identifier

password - the password for the BPEL process domain

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 process domain is hosted

Throws:

ServerException - either one of the following errors:

• cannot authenticate to the domain using the specified password,
• no such domain exists with the specified domain identifier,
• unable to connect to the remote J2EE application server with the specified context properties.

validate

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

Validates a set of domain authentication credentials. This method allows users to test whether a domain authenticator can gain access to a BPEL process domain 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 particular domain

Throws:

ServerException - if cannot authenticate to the domain using the authenticator.

validate

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

Performs the same action as validate( boolean, DomainAuth ) 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 process domain 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 particular domain.

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

Throws:

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

Skip navigation links