org.directwebremoting.ServerContextFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dwr Show documentation

DWR is easy Ajax for Java. It makes it simple to call Java code directly from Javascript. It gets rid of almost all the boiler plate code between the web browser and your Java code.

The newest version!

/*
 * Copyright 2005 Joe Walker
 *
 * 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.directwebremoting;

import javax.servlet.ServletContext;

import org.directwebremoting.extend.Builder;
import org.directwebremoting.extend.Factory;

/**
 * Accessor for the current ServerContext.
 * @author Joe Walker [joe at getahead dot ltd dot uk]
 */
public class ServerContextFactory
{
    /**
     * Accessor for the current ServerContext.
     * @return The current ServerContext.
     */
    public static ServerContext get()
    {
        return factory.get();
    }

    /**
     * This method was designed to support more complex DWR setups, although
     * it is unlikely that it ever did this properly. If you have multiple
     * DWR servlets in a single ServletContext or wish to do cross-context
     * access to DWR then please contact the DWR mailing list.
     * @param ctx The servlet context to allow us to bootstrap
     * @return The current ServerContext.
     * @deprecated Use the plain ServerContextFactory.get() version
     * @see #get()
     */
    @Deprecated
    public static ServerContext get(ServletContext ctx)
    {
        return factory.get();
    }

    /**
     * Internal method to allow us to get the Builder from which we
     * will get ServerContext objects.
     * Do NOT call this method from outside of DWR.
     */
    public static ServerContext attach(Container container)
    {
        return factory.attach(container);
    }

    /**
     * The factory helper class
     */
    private static Factory factory = Factory.create(ServerContextBuilder.class);

    /**
     * Hack to get around Generics not being implemented by erasure
     */
    public interface ServerContextBuilder extends Builder
    {
    }
}