01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.auth;
18:
19: /**
20: * This component loads/saves application data for a user. If an application
21: * has an application store, the {@link #loadApplicationData(User, Application)}
22: * is executed after the user has logged into the application. The loaded
23: * data object is stored in the session, see {@link org.apache.cocoon.auth.ApplicationUtil}.
24: * Calling the {@link #saveApplicationData(User, Application, Object)} is the
25: * task of the application.
26: *
27: * @version $Id: ApplicationStore.java 433543 2006-08-22 06:22:54Z crossley $
28: */
29: public interface ApplicationStore {
30:
31: /**
32: * Load data for the given user and application.
33: * For session replication to work this data should be {@link java.io.Serializable}.
34: * @param user The current user.
35: * @param app The current application.
36: * @return The loaded data or null.
37: */
38: Object loadApplicationData(User user, Application app);
39:
40: /**
41: * Save the data for the given user and application.
42: * @param user The current user.
43: * @param app The current application.
44: * @param data The user data.
45: */
46: void saveApplicationData(User user, Application app, Object data);
47: }
|