woko.facets.BaseFacet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of woko-core Show documentation
The newest version!
/*
 * Copyright 2001-2012 Remi Vankeisbelck
 *
 * Licensed 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 woko.facets;

import net.sourceforge.jfacets.IFacet;
import net.sourceforge.jfacets.IFacetContext;
import net.sourceforge.jfacets.IFacetDescriptorManager;
import net.sourceforge.jfacets.IInstanceFacet;
import woko.Woko;
import woko.facets.WokoFacetContext;
import woko.persistence.ObjectStore;
import woko.users.UserManager;
import woko.users.UsernameResolutionStrategy;

import javax.servlet.http.HttpServletRequest;

/**
 * Base facet class.
 */
public abstract class BaseFacet<
        OsType extends ObjectStore,
        UmType extends UserManager,
        UnsType extends UsernameResolutionStrategy,
        FdmType extends IFacetDescriptorManager
        > implements IFacet {

    /**
     * Ref to the facet context
     */
    private WokoFacetContext facetContext;

    /**
     * Return the WokoFacetContext for this facet
     * @return the WokoFacetContext
     */
    public WokoFacetContext getFacetContext() {
        return facetContext;
    }

    /**
     * Set the WokoFacetContext for this facet
     * @param iFacetContext the WokoFacetContext
     */
    @SuppressWarnings("unchecked")
    public void setFacetContext(IFacetContext iFacetContext) {
        this.facetContext = (WokoFacetContext) iFacetContext;
    }

    /**
     * Return the Woko instance
     * @return the Woko instance
     */
    public Woko getWoko() {
        return getFacetContext().getWoko();
    }

    /**
     * Return the ObjectStore
     * @return the ObjectStore
     */
    public OsType getObjectStore() {
        return getWoko().getObjectStore();
    }

    /**
     * Return the request
     * @return the request
     */
    public HttpServletRequest getRequest() {
        return facetContext.getRequest();
    }

}