KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > portal > wsrp > consumer > UserContextProvider


1 /*
2  * Copyright 2005 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.portal.wsrp.consumer;
17
18 /**
19  * This component provides the {@link oasis.names.tc.wsrp.v1.types.UserContext}
20  * for a portal user.
21  * Cocoon uses an extension of the user context: {@link UserContextExtension}
22  * to store additional information about the user.
23  *
24  * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
25  * @author <a HREF="mailto:malessandrini@s-und-n.de">Michel Alessandrini</a>
26  *
27  * @version $Id: UserContextProvider.java 264755 2005-08-30 10:29:21Z cziegeler $
28  */
29 public interface UserContextProvider {
30
31     /** The component role. */
32     String JavaDoc ROLE = UserContextProvider.class.getName();
33
34     /**
35      * Delivers a <tt>UserContext</tt>-object for the given User-id <br />
36      * the data will be read out of an individual location <br />
37      *
38      * @param userId
39      * @return UserContextExtension
40      */
41     UserContextExtension createUserContext(String JavaDoc userId);
42 }
43
Popular Tags