/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.portalsite;
import java.io.Serializable;
import java.util.Map;
import org.apache.jetspeed.page.PageManager;
/**
* This describes the session context for the portal-site component.
*
* @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
* @version $Id: PortalSiteSessionContext.java 553375 2007-07-05 05:37:00Z taylor $
*/
public interface PortalSiteSessionContext extends Serializable
{
/**
* newRequestContext - create a new request context instance with fallback and history
*
* @param requestProfileLocators request profile locators
* @return new request context instance
*/
PortalSiteRequestContext newRequestContext(Map requestProfileLocators);
/**
* newRequestContext - create a new request context instance with history
*
* @param requestProfileLocators request profile locators
* @param requestFallback flag specifying whether to fallback to root folder
* if locators do not select a page or access is forbidden
* @return new request context instance
*/
PortalSiteRequestContext newRequestContext(Map requestProfileLocators, boolean requestFallback);
/**
* newRequestContext - create a new request context instance
*
* @param requestProfileLocators request profile locators
* @param requestFallback flag specifying whether to fallback to root folder
* if locators do not select a page or access is forbidden
* @param useHistory flag indicating whether to use visited page
* history to select default page per site folder
* @return new request context instance
*/
PortalSiteRequestContext newRequestContext(Map requestProfileLocators, boolean requestFallback, boolean useHistory);
/**
* getPageManager - return PageManager component instance
*
* @return PageManager instance
*/
PageManager getPageManager();
/**
* isValid - return flag indicating whether this context instance
* is valid or if it is stale after being persisted and
* reloaded as session state
*
* @return valid context status
*/
boolean isValid();
/**
* set which pipeline this context is stored for
*
* @param pipeline
*/
void setPipeline(String pipeline);
/**
* get which pipeline this context is stored for
*/
String getPipeline();
}
|