public class JBossClientAuthConfig extends Object implements ClientAuthConfig
Constructor and Description |
---|
JBossClientAuthConfig(String layer,
String appContext,
CallbackHandler handler,
Map properties)
Create a new JBossClientAuthConfig.
|
Modifier and Type | Method and Description |
---|---|
String |
getAppContext()
Get the application context identifier of this authentication context configuration object.
|
ClientAuthContext |
getAuthContext(String authContextID,
Subject clientSubject,
Map properties)
Get a ClientAuthContext instance from this ClientAuthConfig.
|
String |
getAuthContextID(MessageInfo messageInfo)
Get the authentication context identifier corresponding to the request and response objects encapsulated in
messageInfo.
|
List |
getClientAuthModules() |
String |
getMessageLayer()
Get the message layer name of this authentication context configuration object.
|
boolean |
isProtected()
Used to determine whether the authentication context configuration object encapsulates any protected
authentication contexts.
|
void |
refresh()
Causes a dynamic authentication context configuration object to update the internal state that it uses to
process calls to its getAuthContext method.
|
public JBossClientAuthConfig(String layer, String appContext, CallbackHandler handler, Map properties)
layer
- Message LayerappContext
- Application Contexthandler
- Callback Handler to be passed to auth modulesproperties
- Contextual propertiespublic ClientAuthContext getAuthContext(String authContextID, Subject clientSubject, Map properties) throws AuthException
ClientAuthConfig
Get a ClientAuthContext instance from this ClientAuthConfig.
The implementation of this method returns a ClientAuthContext instance that encapsulates the ClientAuthModules used to secure and validate requests/responses associated with the given authContextID.
Specifically, this method accesses this ClientAuthConfig object with the argument authContextID to determine the ClientAuthModules that are to be encapsulated in the returned ClientAuthContext instance.
The ClientAuthConfig object establishes the request and response MessagePolicy objects that are passed to the encapsulated modules when they are initialized by the returned ClientAuthContext instance. It is the modules’ responsibility to enforce these policies when invoked.
getAuthContext
in interface ClientAuthConfig
authContextID
- A String identifier used to index the provided config, or null.
This value must be identical to the value returned by the getAuthContextID
method for all MessageInfo objects passed to the secureRequest method
of the returned ClientAuthContext.clientSubject
- A Subject that represents the source of the service request to be secured by the
acquired authentication context. The principals and credentials of the Subject may be used to select or
acquire the authentication context. If the Subject is not null, additional Principals or credentials
(pertaining to the source of the request) may be added to the Subject. A null value may be passed for
this parameter.properties
- A Map object that may be used by the caller to augment the properties that will be
passed to the encapsulated modules at module initialization. The null value may be passed for this
parameter.AuthException
- if this method fails.ClientAuthConfig.getAuthContext(String, javax.security.auth.Subject, java.util.Map)
public String getMessageLayer()
AuthConfig
Get the message layer name of this authentication context configuration object.
getMessageLayer
in interface AuthConfig
AuthConfig.getMessageLayer()
public void refresh()
AuthConfig
Causes a dynamic authentication context configuration object to update the internal state that it uses to process calls to its getAuthContext method.
refresh
in interface AuthConfig
AuthConfig.refresh()
public List getClientAuthModules()
public String getAppContext()
AuthConfig
Get the application context identifier of this authentication context configuration object.
getAppContext
in interface AuthConfig
public String getAuthContextID(MessageInfo messageInfo)
AuthConfig
Get the authentication context identifier corresponding to the request and response objects encapsulated in messageInfo.
getAuthContextID
in interface AuthConfig
messageInfo
- A contextual Object that encapsulates the client request and server response objects.public boolean isProtected()
AuthConfig
Used to determine whether the authentication context configuration object encapsulates any protected authentication contexts.
isProtected
in interface AuthConfig
Copyright © 2016 JBoss by Red Hat. All rights reserved.