-
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
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-javax/xml/ws/WebServiceContext.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.