-
public interface WebServiceContext
AWebServiceContext
makes it possible for a web service endpoint implementation class to access message context and security information relative to a request being served. Typically aWebServiceContext
is injected into an endpoint implementation class using theResource
annotation.- Since:
- JAX-WS 2.0
- See Also:
Resource
-
-
Method Summary
Methods Modifier and Type Method and Description <T extends EndpointReference>
TgetEndpointReference(Class<T> clazz, Element... referenceParameters)
Returns theEndpointReference
associated with this endpoint.EndpointReference
getEndpointReference(Element... referenceParameters)
Returns theEndpointReference
for this endpoint.MessageContext
getMessageContext()
Returns theMessageContext
for the request being served at the time this method is called.Principal
getUserPrincipal()
Returns the Principal that identifies the sender of the request currently being serviced.boolean
isUserInRole(String role)
Returns a boolean indicating whether the authenticated user is included in the specified logical role.
-
-
-
Method Detail
-
getMessageContext
MessageContext getMessageContext()
Returns theMessageContext
for the request being served at the time this method is called. Only properties with APPLICATION scope will be visible to the application.- Returns:
- MessageContext The message context.
- Throws:
IllegalStateException
- This exception is thrown if the method is called while no request is being serviced.- See Also:
MessageContext
,MessageContext.Scope
,IllegalStateException
-
getUserPrincipal
Principal getUserPrincipal()
Returns the Principal that identifies the sender of the request currently being serviced. If the sender has not been authenticated, the method returnsnull
.- Returns:
- Principal The principal object.
- Throws:
IllegalStateException
- This exception is thrown if the method is called while no request is being serviced.- See Also:
Principal
,IllegalStateException
-
isUserInRole
boolean isUserInRole(String role)
Returns a boolean indicating whether the authenticated user is included in the specified logical role. If the user has not been authenticated, the method returnsfalse
.- Parameters:
role
- AString
specifying the name of the role- Returns:
- a
boolean
indicating whether the sender of the request belongs to a given role - Throws:
IllegalStateException
- This exception is thrown if the method is called while no request is being serviced.
-
getEndpointReference
EndpointReference getEndpointReference(Element... referenceParameters)
Returns theEndpointReference
for this endpoint.If the
Binding
for thisbindingProvider
is either SOAP1.1/HTTP or SOAP1.2/HTTP, then aW3CEndpointReference
MUST be returned.- Parameters:
referenceParameters
- Reference parameters to be associated with the returnedEndpointReference
instance.- Returns:
- EndpointReference of the endpoint associated with this
WebServiceContext
. If the returnedEndpointReference
is of typeW3CEndpointReference
then it MUST contain the the specifiedreferenceParameters
. - Throws:
IllegalStateException
- This exception is thrown if the method is called while no request is being serviced.- Since:
- JAX-WS 2.1
- See Also:
W3CEndpointReference
-
getEndpointReference
<T extends EndpointReference> T getEndpointReference(Class<T> clazz, Element... referenceParameters)
Returns theEndpointReference
associated with this endpoint.- Parameters:
clazz
- The type ofEndpointReference
that MUST be returned.referenceParameters
- Reference parameters to be associated with the returnedEndpointReference
instance.- Returns:
- EndpointReference of type
clazz
of the endpoint associated with thisWebServiceContext
instance. If the returnedEndpointReference
is of typeW3CEndpointReference
then it MUST contain the the specifiedreferenceParameters
. - Throws:
IllegalStateException
- This exception is thrown if the method is called while no request is being serviced.WebServiceException
- If theclazz
type ofEndpointReference
is not supported.- Since:
- JAX-WS 2.1
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/12/2024 09:03:18 Cette version de la page est en cache (à la date du 22/12/2024 09:03:18) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/xml/ws/WebServiceContext.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.