com.aspectran.web.service.WebService Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2023 The Aspectran Project
*
* 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 com.aspectran.web.service;
import com.aspectran.core.service.CoreService;
import jakarta.servlet.ServletContext;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* The Interface WebService.
*
* Created: 2017. 10. 28.
*/
public interface WebService extends CoreService {
/**
* ServletContext attribute name used to obtain the root WebService object.
*/
String ROOT_WEB_SERVICE_ATTR_NAME = WebService.class.getName() + ".ROOT";
/**
* The prefix of the ServletContext property name used to get the standalone WebService object.
*/
String STANDALONE_WEB_SERVICE_ATTR_PREFIX = WebService.class.getName() + ".STANDALONE:";
/**
* Returns a reference to the {@link ServletContext} in which this WebService is running.
* @return a {@link ServletContext} object, used by this WebService to interact with
* its servlet container
*/
ServletContext getServletContext();
/**
* Executes web activity.
* @param request current HTTP servlet request
* @param response current HTTP servlet response
* @throws IOException If an error occurs during Activity execution
*/
void service(HttpServletRequest request, HttpServletResponse response) throws IOException;
}