KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openejb > client > AuthenticationRequest


1 /**
2  * Redistribution and use of this software and associated documentation
3  * ("Software"), with or without modification, are permitted provided
4  * that the following conditions are met:
5  *
6  * 1. Redistributions of source code must retain copyright
7  * statements and notices. Redistributions must also contain a
8  * copy of this document.
9  *
10  * 2. Redistributions in binary form must reproduce the
11  * above copyright notice, this list of conditions and the
12  * following disclaimer in the documentation and/or other
13  * materials provided with the distribution.
14  *
15  * 3. The name "OpenEJB" must not be used to endorse or promote
16  * products derived from this Software without prior written
17  * permission of The OpenEJB Group. For written permission,
18  * please contact dev@openejb.org.
19  *
20  * 4. Products derived from this Software may not be called "OpenEJB"
21  * nor may "OpenEJB" appear in their names without prior written
22  * permission of The OpenEJB Group. OpenEJB is a registered
23  * trademark of The OpenEJB Group.
24  *
25  * 5. Due credit should be given to the OpenEJB Project
26  * (http://www.openejb.org/).
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE OPENEJB GROUP AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32  * THE OPENEJB GROUP OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39  * OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Copyright 2001 (C) The OpenEJB Group. All Rights Reserved.
42  *
43  * $Id: AuthenticationRequest.java 1921 2005-06-19 22:40:34Z jlaskowski $
44  */
45 package org.openejb.client;
46
47 import java.io.IOException JavaDoc;
48 import java.io.ObjectInput JavaDoc;
49 import java.io.ObjectOutput JavaDoc;
50
51 /**
52  *
53  * @author <a HREF="mailto:david.blevins@visi.com">David Blevins</a>
54  * @since 11/25/2001
55  */
56 public class AuthenticationRequest implements Request {
57     
58     /**
59      * The principle of the client. Can be a user name or some other id.
60      */
61     private transient Object JavaDoc principle;
62     /**
63      * The client's credentials proves they are who they say they are. Can be
64      * a password, passphrase, certificate, etc.
65      */
66     private transient Object JavaDoc credentials;
67
68     /**
69      * Constructs a new AuthenticationRequest to send to the server.
70      */
71     public AuthenticationRequest() {
72     }
73     
74     /**
75      * Constructs a new AuthenticationRequest to send to the server.
76      *
77      * @param principle
78      * @param credentials
79      */
80     public AuthenticationRequest(Object JavaDoc principle, Object JavaDoc credentials) {
81         this.principle = principle;
82         this.credentials = credentials;
83     }
84     
85     public byte getRequestType(){
86         return AUTH_REQUEST;
87     }
88     
89
90     /**
91      * Returns the client's principle.
92      *
93      * @return Object
94      */
95     public Object JavaDoc getPrinciple(){
96         return principle;
97     }
98     
99     /**
100      * Returns the client's credentials.
101      *
102      * @return Object
103      */
104     public Object JavaDoc getCredentials(){
105         return credentials;
106     }
107     
108     /**
109      * Sets the client's principle.
110      *
111      * @param principle
112      */
113     public void setPrinciple(Object JavaDoc principle){
114         this.principle = principle;
115     }
116     
117     /**
118      * Sets the clients credentials.
119      *
120      * @param credentials
121      */
122     public void setCredentials(Object JavaDoc credentials){
123         this.credentials = credentials;
124     }
125     
126     /**
127      * The object implements the readExternal method to restore its
128      * contents by calling the methods of DataInput for primitive
129      * types and readObject for objects, strings and arrays. The
130      * readExternal method must read the values in the same sequence
131      * and with the same types as were written by writeExternal.
132      *
133      * @param in the stream to read data from in order to restore the object
134      * @exception IOException if I/O errors occur
135      * @exception ClassNotFoundException If the class for an object being
136      * restored cannot be found.
137      */
138     public void readExternal(ObjectInput JavaDoc in) throws IOException JavaDoc,ClassNotFoundException JavaDoc {
139         principle = in.readObject();
140         credentials = in.readObject();
141     }
142     /**
143      * The object implements the writeExternal method to save its contents
144      * by calling the methods of DataOutput for its primitive values or
145      * calling the writeObject method of ObjectOutput for objects, strings,
146      * and arrays.
147      *
148      * @param out the stream to write the object to
149      * @exception IOException
150      * Includes any I/O exceptions that may occur
151      */
152     public void writeExternal(ObjectOutput JavaDoc out) throws IOException JavaDoc {
153         out.writeObject(principle );
154         out.writeObject(credentials);
155     }
156 }
157
158
159
Popular Tags