-
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
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/xml/ws/WebServiceContext.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.