SRPServiceMBean


1   /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22  package org.jboss.security.srp;
23  
24  import org.jboss.invocation.Invocation;
25  import org.jboss.system.ServiceMBean;
26  
27  /**
28   * The JMX mbean interface for the SRP service. This mbean sets up an
29   * RMI implementation of the 'Secure Remote Password' cryptographic authentication
30   * system developed by Tom Wu (tjw@CS.Stanford.EDU). For more info on SRP
31   * see http://www-cs-students.stanford.edu/~tjw/srp/.
32   *
33   * @author Scott.Stark@jboss.org
34   * @version $Revision: 40096 $
35   */
36  public interface SRPServiceMBean
37     extends ServiceMBean
38  {
39     /**
40      * Get the jndi name for the SRPVerifierSource implementation binding.
41      */
42     String   getVerifierSourceJndiName();
43     
44     /**
45      * set the jndi name for the SRPVerifierSource implementation binding.
46      */
47     void setVerifierSourceJndiName(String   jndiName);
48     
49     /**
50      * Get the jndi name under which the SRPServerInterface proxy should be bound
51      */
52     String   getJndiName();
53     
54     /**
55      * Set the jndi name under which the SRPServerInterface proxy should be bound
56      */
57     void setJndiName(String   jndiName);
58     
59     /**
60      * Get the jndi name under which the SRPServerInterface proxy should be bound
61      */
62     String   getAuthenticationCacheJndiName();
63     
64     /**
65      * Set the jndi name under which the SRPServerInterface proxy should be bound
66      */
67     void setAuthenticationCacheJndiName(String   jndiName);
68  
69     /**
70      * Get the auth cache timeout period in seconds
71      */
72     int getAuthenticationCacheTimeout();
73     
74     /**
75      * Set the auth cache timeout period in seconds
76      */
77     void setAuthenticationCacheTimeout(int timeoutInSecs);
78     
79     /**
80      * Get the auth cache resolution period in seconds
81      */
82     int getAuthenticationCacheResolution();
83     
84     /**
85      * Set the auth cache resolution period in seconds
86      */
87     void setAuthenticationCacheResolution(int resInSecs);
88  
89     /** Get if the client must supply an auxillary challenge as part of the
90      * verify phase.
91      */
92     public boolean getRequireAuxChallenge();
93     /** Set if the client must supply an auxillary challenge as part of the
94      * verify phase.
95      */
96     public void setRequireAuxChallenge(boolean flag);
97  
98     /** A flag indicating if a successful user auth for an existing session
99      should overwrite the current session.
100     */
101    public boolean getOverwriteSessions();
102    /** Set the flag indicating if a successful user auth for an existing session
103     should overwrite the current session.
104     */
105    public void setOverwriteSessions(boolean flag);
106 
107    /**
108     * Get the RMIClientSocketFactory implementation class. If null the default
109     * RMI client socket factory implementation is used.
110     */
111    String   getClientSocketFactory();
112    
113    /**
114     * Set the RMIClientSocketFactory implementation class. If null the default
115     * RMI client socket factory implementation is used.
116     */
117    void setClientSocketFactory(String   factoryClassName)
118       throws ClassNotFoundException  , InstantiationException  , IllegalAccessException  ;
119    
120    /**
121     * Get the RMIServerSocketFactory implementation class. If null the default
122     * RMI server socket factory implementation is used.
123     */
124    String   getServerSocketFactory();
125    
126    /**
127     * Set the RMIServerSocketFactory implementation class. If null the default
128     * RMI server socket factory implementation is used.
129     */
130    void setServerSocketFactory(String   factoryClassName)
131       throws ClassNotFoundException  , InstantiationException  , IllegalAccessException  ;
132    
133    /**
134     * Get the RMI port for the SRPRemoteServerInterface
135     */
136    int getServerPort();
137    
138    /**
139     * Set the RMI port for the SRPRemoteServerInterface
140     */
141    void setServerPort(int port);
142 
143    /** Expose the Invoker signature via JMX
144    */
145    public Object   invoke(Invocation invocation) throws Exception  ;
146 }
147
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags