FileDocCategorySizeDatePackage
EntryContext.javaAPI DocGlassfish v2 API3500Fri May 04 22:35:48 BST 2007com.sun.enterprise.server.ondemand.entry

EntryContext.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.enterprise.server.ondemand.entry;

import com.sun.enterprise.server.ServerContext;


/**
 * Context of an entry to a servicegroup.
 * Each entry point generate such an EntryContext.
 * This object contains information regarding the entry.
 * Servicegroups use this EntryContext to examine the
 * entry request.
 *
 * @author Binod PG
 * @see EntryPoint 
 * @see ServerEntryListener 
 * @see ServiceGroup
 */
public class EntryContext {

    private Object context = null;
    private int type = -1;
    private ServerContext sc = null;

    /**
     * Creates an entrycontext. 
     * @param context COntext generated by entrypoints.
     * @param type One of the types specified in 
     * <code>EntryPoint</code> interface
     */
    public EntryContext(Object context, int type) {
        this.context = context;
        this.type = type;
    }

    // Return the type of entry.
    public int getEntryPointType() {
        return this.type;
    }

    // Set the entry point type
    public void setEntryPointType (int type) {
        this.type = type;
    }

    // Return the actual entry context.
    public Object get() {
        return context;
    }

    // Set the server context object. This will be used by
    // ServiceGroups.
    public void setServerContext(ServerContext sc) {
        this.sc = sc;
    }

    // Return the server context object.
    public ServerContext getServerContext() {
        return this.sc;
    }

    public String toString() {
        return "[ Entry context ] ...[ " + context + " ]";
    }

}