|
JBoss Security SPI - Aggregator 2.0.4.SP8 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jboss.security.client.SecurityClient
public abstract class SecurityClient
Generic Security Client class
Basic Users:
Basic users will just use the methods that set the username and credential
#setUserName(String)} and @see {@link #setCredential(Object)}
Intermediate Users:
You can specify usage of JAAS as the framework in the client implementation.
In this case, you will @see {@link #setLoginConfigName(String)} and
,
Advanced Users:
You will use the @see {@link #setSASLMechanism(String)} method
Field Summary | |
---|---|
protected CallbackHandler |
callbackHandler
|
protected Object |
credential
|
protected boolean |
jaasDesired
|
protected String |
loginConfigName
|
protected String |
saslAuthorizationId
|
protected boolean |
saslDesired
|
protected String |
saslMechanism
|
protected Object |
userPrincipal
|
protected boolean |
vmwideAssociation
Perform a VMWide association of security context |
Constructor Summary | |
---|---|
SecurityClient()
|
Method Summary | |
---|---|
protected abstract void |
cleanUp()
Provide an opportunity for client implementations to clean up |
boolean |
isVmwideAssociation()
Is the Security Context establishment vm wide? |
void |
login()
Login with the desired method |
void |
logout()
Log Out |
protected abstract void |
peformSASLLogin()
|
protected abstract void |
performJAASLogin()
|
protected abstract void |
performSimpleLogin()
|
void |
setJAAS(String configName,
CallbackHandler cbh)
Set the JAAS Login Configuration Name and Call back handler |
void |
setSASL(String mechanism,
String authorizationId,
CallbackHandler cbh)
Set the mechanism and other parameters for SASL Client |
void |
setSimple(Object username,
Object credential)
Set the user name and credential for simple login (non-jaas, non-sasl) |
void |
setVmwideAssociation(boolean vmwideAssociation)
Set the vm wide association of security context (Default : false)s |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Object userPrincipal
protected Object credential
protected CallbackHandler callbackHandler
protected String loginConfigName
protected String saslMechanism
protected String saslAuthorizationId
protected boolean jaasDesired
protected boolean saslDesired
protected boolean vmwideAssociation
Constructor Detail |
---|
public SecurityClient()
Method Detail |
---|
public void login() throws LoginException
LoginException
public void logout()
public void setSimple(Object username, Object credential)
username
- (Can be null)credential
- (Can be null)public void setJAAS(String configName, CallbackHandler cbh)
configName
- can be nullcbh
- can be nullpublic void setSASL(String mechanism, String authorizationId, CallbackHandler cbh)
mechanism
- authorizationId
- cbh
- protected abstract void performJAASLogin() throws LoginException
LoginException
protected abstract void peformSASLLogin()
protected abstract void performSimpleLogin()
public boolean isVmwideAssociation()
public void setVmwideAssociation(boolean vmwideAssociation)
vmwideAssociation
- protected abstract void cleanUp()
|
JBoss Security SPI - Aggregator 2.0.4.SP8 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |