SockJsServiceFactory.java

/*
 * Copyright 2013 The Netty Project
 *
 * The Netty Project licenses this file to you 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.jboss.aerogear.io.netty.handler.codec.sockjs;

/**
 * A factory for creating {@link SockJsService} instances.
 */
public interface SockJsServiceFactory {

    /**
     * Creates a new instance, or reuse and existing instance, of the service.
     * Allows for either creating new instances for every session of to use
     * a single instance, whatever is appropriate for the use case.
     *
     * @return {@link SockJsService} the service instance.
     */
    SockJsService create();

    /**
     * The {@link SockJsConfig} for the session itself.
     *
     * @return Config the configuration for the session.
     */
    SockJsConfig config();

}