org.atmosphere.util.EndpointMapper Maven / Gradle / Ivy
/*
* Copyright 2008-2024 Async-IO.org
*
* 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.atmosphere.util;
import org.atmosphere.cpr.AtmosphereRequest;
import org.atmosphere.inject.AtmosphereConfigAware;
import java.util.Map;
/**
* This class is responsible for mapping request to handler like {@link org.atmosphere.cpr.AtmosphereHandler}
* or {@link org.atmosphere.websocket.WebSocketHandler}
*
* @param
* @author Jeanfrancois Arcand
*/
public interface EndpointMapper extends AtmosphereConfigAware {
/**
* Mape the request to its associated endpoint.
*
* @param req an {@link AtmosphereRequest}
* @param handlers a map used for mapping the request to.
* @return U the result, or null if not mapped
*/
U map(AtmosphereRequest req, Map handlers);
/**
* Mape the request to its associated endpoint.
*
* @param path a URI
* @param handlers a map used for mapping the request to.
* @return U the result, or null if not mapped
*/
U map(String path, Map handlers);
}