Package org.glassfish.jersey.servlet

Class ServletPropertiesDelegate

java.lang.Object

org.glassfish.jersey.servlet.ServletPropertiesDelegate

All Implemented Interfaces:

PropertiesDelegate

class ServletPropertiesDelegate
extends java.lang.Object
implements PropertiesDelegate

Field Summary

Fields

Modifier and Type	Field	Description
private javax.servlet.http.HttpServletRequest	request

Constructor Summary

Constructors

Constructor	Description
ServletPropertiesDelegate(javax.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getProperty(java.lang.String name)	Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.
java.util.Collection<java.lang.String>	getPropertyNames()	Returns an immutable collection containing the property names available within the context of the current request/response exchange context.
void	removeProperty(java.lang.String name)	Removes a property with the given name from the current request/response exchange context.
void	setProperty(java.lang.String name, java.lang.Object object)	Binds an object to a given property name in the current request/response exchange context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

request

private final javax.servlet.http.HttpServletRequest request

Constructor Detail

ServletPropertiesDelegate

public ServletPropertiesDelegate(javax.servlet.http.HttpServletRequest request)

Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String name)

Description copied from interface: PropertiesDelegate

Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.

A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

A list of supported properties can be retrieved using PropertiesDelegate.getPropertyNames(). Custom property names should follow the same convention as package names.

Specified by:

getProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property.

Returns:

an Object containing the value of the property, or null if no property exists matching the given name.

See Also:

PropertiesDelegate.getPropertyNames()

getPropertyNames

public java.util.Collection<java.lang.String> getPropertyNames()

Description copied from interface: PropertiesDelegate

Returns an immutable collection containing the property names available within the context of the current request/response exchange context.

Use the PropertiesDelegate.getProperty(java.lang.String) method with a property name to get the value of a property.

Specified by:

getPropertyNames in interface PropertiesDelegate

Returns:

an immutable collection of property names.

See Also:

PropertiesDelegate.getProperty(java.lang.String)

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object object)

Description copied from interface: PropertiesDelegate

Binds an object to a given property name in the current request/response exchange context. If the name specified is already used for a property, this method will replace the value of the property with the new value.

A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

A list of supported properties can be retrieved using PropertiesDelegate.getPropertyNames(). Custom property names should follow the same convention as package names.

If a null value is passed, the effect is the same as calling the PropertiesDelegate.removeProperty(String) method.

Specified by:

setProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property.

object - an Object representing the property to be bound.

removeProperty

public void removeProperty(java.lang.String name)

Description copied from interface: PropertiesDelegate

Removes a property with the given name from the current request/response exchange context. After removal, subsequent calls to PropertiesDelegate.getProperty(java.lang.String) to retrieve the property value will return null.

Specified by:

removeProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property to be removed.