org.directwebremoting.extend.Builder 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.extend;

import org.directwebremoting.Container;
import org.directwebremoting.ServerContext;
import org.directwebremoting.ServerContextFactory;

/**
 * Class to enable us to build 'singleton' interface implementations.
 * It is assumed that there is one 'singleton' per {@link ServerContext}.
 * Both this class and implementations of it are generally for use by DWR
 * developers. If you are a DWR user then unless you're doing something very
 * deep, you're probably digging too far.
 * @author Joe Walker [joe at getahead dot ltd dot uk]
 */
public interface Builder
{
    /**
     * Get the object that is associated with this thread, assuming that there
     * is no confusion over the current {@link ServerContext}.
     * There is more than one {@link ServerContext} then you need to use
     * {@link #get(ServerContext)} to ensure that the correct one is used.
     * @return The object associated with this DWR instance
     */
    T get();

    /**
     * Get the object that is associated with this thread, whilst specifying
     * the correct {@link ServerContext}.
     * @param context The web application environment
     * @return The object that is associated with this web application
     */
    T get(ServerContext context);

    /**
     * This method should be called during setup only.
     * This is a bit like {@link InitializingBean#afterContainerSetup}
     * except that it is called by {@link Factory#attach} which is
     * called after the container has finished setting itself up so we can
     * rely on {@link ServerContextFactory#get()} working.
     */
    T attach(Container container);
}