All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.ws.developer.servlet.HttpSessionScope Maven / Gradle / Ivy

The newest version!
/*
 * Copyright (c) 1997, 2022 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package com.sun.xml.ws.developer.servlet;

import com.sun.xml.ws.api.server.InstanceResolverAnnotation;
import com.sun.xml.ws.server.servlet.HttpSessionInstanceResolver;

import jakarta.jws.WebService;
import jakarta.servlet.http.HttpSession;
import jakarta.xml.ws.spi.WebServiceFeatureAnnotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Designates a service class that should be tied to {@link HttpSession} scope.
 *
 * 

* When a service class is annotated with this annotation like the following, * the JAX-WS RI runtime will instanciate a new instance of the service class for * each {@link HttpSession}. * *

 * @{@link WebService}
 * @{@link HttpSessionScope}
 * class CounterService {
 *     protected int count = 0;
 *
 *     public CounterService() {}
 *
 *     public int inc() {
 *         return count++;
 *     }
 * }
 * 
* *

* This allows you to use instance fields for storing per-session state * (in the above example, it will create a separate counter for each client.) * *

* The service instance will be GCed when the corresponding {@link HttpSession} * is GCed. Refer to servlet documentation for how to configure the timeout behavior. * * @author Kohsuke Kawaguchi * @since JAX-WS 2.1 */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) @Documented @WebServiceFeatureAnnotation(id=HttpSessionScopeFeature.ID, bean=HttpSessionScopeFeature.class) @InstanceResolverAnnotation(HttpSessionInstanceResolver.class) public @interface HttpSessionScope { }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy