tapestry/tapestry-framework/src/java/org/apache/tapestry/engine/HomeService.java

// Copyright 2004, 2005 The Apache Software Foundation
//
// 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 org.apache.tapestry.engine;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import org.apache.tapestry.IRequestCycle;
import org.apache.tapestry.Tapestry;
import org.apache.tapestry.services.LinkFactory;
import org.apache.tapestry.services.ResponseRenderer;
import org.apache.tapestry.services.ServiceConstants;

/**
 * An implementation of the home service that renders the Home page. This is the
 * most likely candidate for overriding ... for example, to select the page to
 * render based on known information about the user (stored as a cookie).
 * 
 * @author Howard Lewis Ship
 * @since 1.0.9
 */

public class HomeService implements IEngineService
{

    /** @since 4.0 */
    private ResponseRenderer _responseRenderer;

    /** @since 4.0 */

    private LinkFactory _linkFactory;

    /** @since 4.0 */

    private String _pageName;

    public ILink getLink(boolean post, Object parameter)
    {
        if (parameter != null)
            throw new IllegalArgumentException(EngineMessages
                    .serviceNoParameter(this));

        Map parameters = new HashMap();

        parameters.put(ServiceConstants.SERVICE, getName());

        return _linkFactory.constructLink(this, post, parameters, true);
    }

    public void service(IRequestCycle cycle)
        throws IOException
    {
        cycle.activate(_pageName);

        _responseRenderer.renderResponse(cycle);
    }

    public String getName()
    {
        return Tapestry.HOME_SERVICE;
    }

    /** @since 4.0 */
    public void setResponseRenderer(ResponseRenderer responseRenderer)
    {
        _responseRenderer = responseRenderer;
    }

    /** @since 4.0 */
    public void setLinkFactory(LinkFactory linkFactory)
    {
        _linkFactory = linkFactory;
    }

    /** @since 4.0 */
    public void setPageName(String pageName)
    {
        _pageName = pageName;
    }

    /** @since 4.0 */
    public String getPageName()
    {
        return _pageName;
    }
}