org.jboss.security.srp
Class SRPService

java.lang.Object
  org.jboss.mx.util.JBossNotificationBroadcasterSupport
      org.jboss.system.ServiceMBeanSupport
          org.jboss.security.srp.SRPService

All Implemented Interfaces:

javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, SRPServerListener, SRPServiceMBean, org.jboss.system.Service, org.jboss.system.ServiceMBean

public class SRPService
extends org.jboss.system.ServiceMBeanSupport
implements SRPServiceMBean, SRPServerListener

The JMX mbean interface for the SRP service. This mbean sets up an RMI implementation of the 'Secure Remote Password' cryptographic authentication system described in RFC2945.

Version:

$Revision: 57210 $

Author:

Scott.Stark@jboss.org

Field Summary

Fields inherited from class org.jboss.system.ServiceMBeanSupport

log, SERVICE_CONTROLLER_SIG, serviceName

Fields inherited from interface org.jboss.system.ServiceMBean

CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED

Constructor Summary

SRPService()

Method Summary

void	closedUserSession(SRPSessionKey key) Called when a user requests that a session be closed
String	getAuthenticationCacheJndiName() Get the jndi name under which the SRPServerInterface proxy should be bound
int	getAuthenticationCacheResolution() Get the auth cache resolution period in seconds
int	getAuthenticationCacheTimeout() Get the auth cache timeout period in seconds
String	getClientSocketFactory() Get the RMIClientSocketFactory implementation class.
String	getJndiName() Get the jndi name under which the SRPServerInterface proxy should be bound
String	getName()
boolean	getOverwriteSessions() A flag indicating if a successful user auth for an existing session should overwrite the current session.
boolean	getRequireAuxChallenge() Get if the client must supply an auxillary challenge as part of the verify phase.
int	getServerPort() Get the RMI port for the SRPServerInterface
String	getServerSocketFactory() Get the RMIServerSocketFactory implementation class.
String	getVerifierSourceJndiName() Get the jndi name for the SRPVerifierSource implementation binding.
Object	invoke(org.jboss.invocation.Invocation invocation) Expose the Invoker signature via JMX
void	setAuthenticationCacheJndiName(String jndiName) Set the jndi name under which the SRPServerInterface proxy should be bound
void	setAuthenticationCacheResolution(int resInSecs) Set the auth cache resolution period in seconds
void	setAuthenticationCacheTimeout(int timeoutInSecs) Set the auth cache timeout period in seconds
void	setClientSocketFactory(String factoryClassName) Set the RMIClientSocketFactory implementation class.
void	setJndiName(String jndiName) Set the jndi name under which the SRPServerInterface proxy should be bound
void	setOverwriteSessions(boolean flag) Set the flag indicating if a successful user auth for an existing session should overwrite the current session.
void	setRequireAuxChallenge(boolean flag) Set if the client must supply an auxillary challenge as part of the verify phase.
void	setServerPort(int serverPort) Get the RMI port for the SRPServerInterface
void	setServerSocketFactory(String factoryClassName) Set the RMIServerSocketFactory implementation class.
void	setVerifierSourceJndiName(String jndiName) set the jndi name for the SRPVerifierSource implementation binding.
protected void	startService()
protected void	stopService()
void	verifiedUser(SRPSessionKey key, SRPServerSession session) Called when username has sucessfully completed the SRP login.

Methods inherited from class org.jboss.system.ServiceMBeanSupport

create, createService, destroy, destroyService, getDeploymentInfo, getLog, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, getState, getStateString, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister, start, stop

Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport

addNotificationListener, getNotificationInfo, handleNotification, nextNotificationSequenceNumber, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.system.ServiceMBean

getState, getStateString, jbossInternalLifecycle

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

Constructor Detail

SRPService

public SRPService()

Method Detail

getVerifierSourceJndiName

public String getVerifierSourceJndiName()

Get the jndi name for the SRPVerifierSource implementation binding.

Specified by:

getVerifierSourceJndiName in interface SRPServiceMBean

setVerifierSourceJndiName

public void setVerifierSourceJndiName(String jndiName)

set the jndi name for the SRPVerifierSource implementation binding.

Specified by:

setVerifierSourceJndiName in interface SRPServiceMBean

getJndiName

public String getJndiName()

Get the jndi name under which the SRPServerInterface proxy should be bound

Specified by:

getJndiName in interface SRPServiceMBean

setJndiName

public void setJndiName(String jndiName)

Set the jndi name under which the SRPServerInterface proxy should be bound

Specified by:

setJndiName in interface SRPServiceMBean

getAuthenticationCacheJndiName

public String getAuthenticationCacheJndiName()

Get the jndi name under which the SRPServerInterface proxy should be bound

Specified by:

getAuthenticationCacheJndiName in interface SRPServiceMBean

setAuthenticationCacheJndiName

public void setAuthenticationCacheJndiName(String jndiName)

Set the jndi name under which the SRPServerInterface proxy should be bound

Specified by:

setAuthenticationCacheJndiName in interface SRPServiceMBean

getAuthenticationCacheTimeout

public int getAuthenticationCacheTimeout()

Get the auth cache timeout period in seconds

Specified by:

getAuthenticationCacheTimeout in interface SRPServiceMBean

setAuthenticationCacheTimeout

public void setAuthenticationCacheTimeout(int timeoutInSecs)

Set the auth cache timeout period in seconds

Specified by:

setAuthenticationCacheTimeout in interface SRPServiceMBean

getAuthenticationCacheResolution

public int getAuthenticationCacheResolution()

Get the auth cache resolution period in seconds

Specified by:

getAuthenticationCacheResolution in interface SRPServiceMBean

setAuthenticationCacheResolution

public void setAuthenticationCacheResolution(int resInSecs)

Set the auth cache resolution period in seconds

Specified by:

setAuthenticationCacheResolution in interface SRPServiceMBean

getRequireAuxChallenge

public boolean getRequireAuxChallenge()

Description copied from interface: SRPServiceMBean

Get if the client must supply an auxillary challenge as part of the verify phase.

Specified by:

getRequireAuxChallenge in interface SRPServiceMBean

setRequireAuxChallenge

public void setRequireAuxChallenge(boolean flag)

Description copied from interface: SRPServiceMBean

Set if the client must supply an auxillary challenge as part of the verify phase.

Specified by:

setRequireAuxChallenge in interface SRPServiceMBean

getOverwriteSessions

public boolean getOverwriteSessions()

Description copied from interface: SRPServiceMBean

A flag indicating if a successful user auth for an existing session should overwrite the current session.

Specified by:

getOverwriteSessions in interface SRPServiceMBean

setOverwriteSessions

public void setOverwriteSessions(boolean flag)

Description copied from interface: SRPServiceMBean

Set the flag indicating if a successful user auth for an existing session should overwrite the current session.

Specified by:

setOverwriteSessions in interface SRPServiceMBean

getClientSocketFactory

public String getClientSocketFactory()

Get the RMIClientSocketFactory implementation class. If null the default RMI client socket factory implementation is used.

Specified by:

getClientSocketFactory in interface SRPServiceMBean

setClientSocketFactory

public void setClientSocketFactory(String factoryClassName)
                            throws ClassNotFoundException,
                                   InstantiationException,
                                   IllegalAccessException

Set the RMIClientSocketFactory implementation class. If null the default RMI client socket factory implementation is used.

Specified by:

setClientSocketFactory in interface SRPServiceMBean

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException

getServerSocketFactory

public String getServerSocketFactory()

Get the RMIServerSocketFactory implementation class. If null the default RMI server socket factory implementation is used.

Specified by:

getServerSocketFactory in interface SRPServiceMBean

setServerSocketFactory

public void setServerSocketFactory(String factoryClassName)
                            throws ClassNotFoundException,
                                   InstantiationException,
                                   IllegalAccessException

Set the RMIServerSocketFactory implementation class. If null the default RMI server socket factory implementation is used.

Specified by:

setServerSocketFactory in interface SRPServiceMBean

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException

getServerPort

public int getServerPort()

Get the RMI port for the SRPServerInterface

Specified by:

getServerPort in interface SRPServiceMBean

setServerPort

public void setServerPort(int serverPort)

Get the RMI port for the SRPServerInterface

Specified by:

setServerPort in interface SRPServiceMBean

verifiedUser

public void verifiedUser(SRPSessionKey key,
                         SRPServerSession session)

Called when username has sucessfully completed the SRP login. This places the SRP session into the credential cache using a SimplePrincipal based on the username as the key.

Specified by:

verifiedUser in interface SRPServerListener

closedUserSession

public void closedUserSession(SRPSessionKey key)

Description copied from interface: SRPServerListener

Called when a user requests that a session be closed

Specified by:

closedUserSession in interface SRPServerListener

getName

public String getName()

Specified by:

getName in interface org.jboss.system.ServiceMBean

Overrides:

getName in class org.jboss.system.ServiceMBeanSupport

invoke

public Object invoke(org.jboss.invocation.Invocation invocation)
              throws Exception

Description copied from interface: SRPServiceMBean

Expose the Invoker signature via JMX

Specified by:

invoke in interface SRPServiceMBean

Throws:

Exception

startService

protected void startService()
                     throws Exception

Overrides:

startService in class org.jboss.system.ServiceMBeanSupport

Throws:

Exception

stopService

protected void stopService()
                    throws Exception

Overrides:

stopService in class org.jboss.system.ServiceMBeanSupport

Throws:

Exception