javax.xml.rpc.server.ServiceLifecycle Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF 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 javax.xml.rpc.server;
import javax.xml.rpc.ServiceException;
/**
* The javax.xml.rpc.server.ServiceLifecycle defines a lifecycle interface for a
* JAX-RPC service endpoint. If the service endpoint class implements the
* ServiceLifeycle interface, the servlet container based JAX-RPC runtime system
* is required to manage the lifecycle of the corresponding service endpoint objects.
*
* @version $Rev: 467553 $ $Date: 2006-10-25 00:01:51 -0400 (Wed, 25 Oct 2006) $
*/
public interface ServiceLifecycle {
/**
* Used for initialization of a service endpoint. After a service
* endpoint instance (an instance of a service endpoint class) is
* instantiated, the JAX-RPC runtime system invokes the
* init method. The service endpoint class uses the
* init method to initialize its configuration
* and setup access to any external resources. The context parameter
* in the init method enables the endpoint instance to
* access the endpoint context provided by the underlying JAX-RPC
* runtime system.
*
* The init method implementation should typecast the context
* parameter to an appropriate Java type. For service endpoints
* deployed on a servlet container based JAX-RPC runtime system,
* the context parameter is of the Java type
* javax.xml.rpc.server.ServletEndpointContext. The
* ServletEndpointContext provides an endpoint context
* maintained by the underlying servlet container based JAX-RPC
* runtime system
*
* @param context Endpoint context for a JAX-RPC service endpoint
* @throws ServiceException If any error in initialization of the service endpoint; or if any
* illegal context has been provided in the init method
*/
public abstract void init(Object context) throws ServiceException;
/**
* JAX-RPC runtime system ends the lifecycle of a service endpoint instance by
* invoking the destroy method. The service endpoint releases its resources in
* the implementation of the destroy method.
*/
public abstract void destroy();
}