KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > security > auth > message > AuthParam


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 javax.security.auth.message;
23
24 import java.util.Map JavaDoc;
25
26 /**
27  * <p>A message processing uses this interface to pass messages to authentication
28  * contexts for processing by authentication modules.</p>
29  *
30  * <p>This interface encapsulates a request message object and a response message
31  * object for a message exchange. This interface may also be used to associate
32  * additional context in the form of key/value pairs, with the encapsulated messages.</p>
33  *
34  * <p>Every implementation of this interface should provide a zero argument
35  * constructor, and a constructor which takes a single Map argument according to the
36  * recommendations in the Map interface. Additional constructors may also be provided.</p>
37  *
38  * <p>An implementation of this interface need not make the request and response
39  * message values available or setable via the methods of its Map interface.</p>
40  *
41  * <p>Implementations of this interface may vary in their support for key and value
42  * types, fail-fast behavior, orderinvariance, and synchronization.</p>
43  *
44  * @author <a HREF="mailto:Anil.Saldhana@jboss.org">Anil Saldhana@jboss.org</a>
45  * @author Charlie Lai, Ron Monzillo (Javadoc for JSR-196)
46  * @since May 11, 2006
47  * @version $Revision: 45179 $
48  */
49 public interface AuthParam extends Map JavaDoc
50 {
51    /**
52     * Get the request message object from this AuthParam.
53     * @return an object representing the request message, or null if no request message
54     * is set within the AuthParam.
55     */
56    public Object JavaDoc getRequestMessage();
57    
58    /**
59     * Get the response message object from this AuthParam.
60     * @return an object representing the response message, or null if no response
61     * message is set within the AuthParam.
62     */
63    public Object JavaDoc getResponseMessage();
64    
65    /**
66     * Set the request message object in this AuthParam.
67     * @param request an object representing the request message.
68     */
69    public void setRequestMessage(Object JavaDoc request);
70    
71    /**
72     * Set the response message object in this AuthParam.
73     * @param response an object representing the response message.
74     */
75    public void setResponseMessage(Object JavaDoc response);
76 }
77
Popular Tags