public interface ConnectionAuthentication
Extensions to the authentication scheme must
Node
ChallengeAuthentication
.
Every authentication scheme must describe itself as a Node
to
allow the scheme to be persisted with the connection metadata. Refer
describe()
. When the connection is loaded by the Connection
manager, the connection reconstructs the authentication scheme from
the metadata provided by describe()
.
A custom AuthenticationScheme must set the provider
attribute when describing its metdata. The provider
defines
the implementing class of the custom authentication scheme. for e.g.
<authentication provider="foo.myCustomAuthScheme" >
< .................... >
</authentication>
Authentication implementations can then be provided by defining the
authenticate(Client conObj)
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTR_PROVIDER
provider attribute in the metdata description.
|
static java.lang.String |
AUTHENTICATION
authentication element in the metdata description.
|
Modifier and Type | Method and Description |
---|---|
void |
authenticate(weblogic.jaxrs.api.client.Client connObj)
Configure the Connection instance using this
authentication scheme.
|
Node |
describe()
Describe this authentication scheme.
|
java.util.Map |
getCredentials()
Fetch the credentials represented by the scheme.
|
void |
loadCredentials(java.util.Map environment)
Load the Authentication Scheme with credentials from Credential
store.
|
static final java.lang.String AUTHENTICATION
static final java.lang.String ATTR_PROVIDER
Node describe() throws ConnectionException
Node
describing the Authentication scheme.{@link
- ConnectionException} if the scheme could not
be described.ConnectionException
void loadCredentials(java.util.Map environment)
Map
represents the environment that has the
security configuration passed by the Connection Manager
which contains the credential properties that this scheme defines.environment
- The environment that has the credential properties
defined by this scheme.java.util.Map getCredentials()
Map
representing the connection
credentials. The password will be char array.void authenticate(weblogic.jaxrs.api.client.Client connObj) throws ConnectionException
conn
- The Client object that should be configured for
necessary authentication headers to be set
when the Connection is prepared for use.{@link
- ConnectionException} If the authentication
fails or an error occurs trying to authenticate.ConnectionException