# com.bea.p13n.http
HttpConfigurableEntity Class

public abstract class HttpConfigurableEntity
extends `Object`
implements `ConfigurableEntity`

A default implementation for Http Request and Http Session objects mimick a ConfigurableEntity. This does not extend the new AbstractConfigurableEntity becuase it is not really storing values based on property sets, just implementing this interface to provide easy access to request and session attributes.

Hierarchy
  `Object`
  `HttpConfigurableEntity`

All Implemented Interfaces
  `ConfigurableEntity`

Direct Known Subclasses
  `Request`, `Session`

## Constructor Summary

HttpConfigurableEntity()

## Method Summary

`public `String`` | `getJndiName`() This method is not supported.
`public final `String`` | `getPkString`() This method is not supported.
`public abstract `Object`` | `getProperty`(`String` propertySet, `String` propertyName) Mimics the two argument `getProperty` method on the new `com.bea.p13n.property.ConfigurableEntity` interface.
`public `Object`` | `getProperty`(`String` propertySet, `String` propertyName, `Object` defaultValue) Provided as convenience method so client code can still provide a default value
`public `String`` | `getPropertyAsString`(`String` set, `String` prop) Provided as convenience method to always return a String or null.
`public static `Object`` | `getPropertyDefault`(`String` propertySetType, `String` propertySet, `String` propertyName) Utility method for retrievng the default value from the PropertySet for the specified type, set, and name.
`public abstract `Object`` | `getPropertyNoDefault`(`String` scopeName, `String` key) Mimics the two argument `getPropertyNoDefault` method on the new `com.bea.p13n.property.ConfigurableEntity` interface.
`public static `PropertySetManager`` | `getPropertySetManager`() Get a reference to the PropertySetManager session bean.
`public long` | `getUniqueId`() This method is not supported.
`public `Object`` | `removeProperty`(`String` aString, `String` aString2) This method is not supported.
`public void` | `setProperty`(`String` aString, `String` aString2, `Object` anObject) This method is not supported.

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `com.bea.p13n.property.`ConfigurableEntity``
``getJndiName`, `getPkString`, `getProperty`, `getPropertyAsString`, `getPropertyNoDefault`, `getUniqueId`, `removeProperty`, `setProperty``

## Constructor Detail

### HttpConfigurableEntity

    public HttpConfigurableEntity()

## Method Detail

### getJndiName() Method

    public String getJndiName()
         throws UnsupportedOperationException

This method is not supported.

#### Returns

the jndi name for this entity

#### Exceptions

``UnsupportedOperationException``

### getPkString() Method

    public final String getPkString()
         throws UnsupportedOperationException

This method is not supported.

#### Returns

the primary key string identifier for this entity

#### Exceptions

``UnsupportedOperationException``

### getProperty(String, String) Method

    public abstract Object getProperty(String propertySet,
                                       String propertyName)

Mimics the two argument `getProperty` method on the new `com.bea.p13n.property.ConfigurableEntity` interface.

#### Parameters

propertySet
  The name of the property set to look in

propertyName
  The name of the property to retrieve.

#### Returns

the value for this property, or null if all searches failed

### getProperty(String, String, Object) Method

    public Object getProperty(String propertySet,
                              String propertyName,
                              Object defaultValue)

Provided as convenience method so client code can still provide a default value

### getPropertyAsString(String, String) Method

    public String getPropertyAsString(String set,
                                      String prop)

Provided as convenience method to always return a String or null.

#### Parameters

set
  The name of the property set to look in

prop
  The name of the property to retrieve.

#### Returns

the value for this property as a String, or null if all searches failed

### getPropertyDefault(String, String, String) Method

    public static Object getPropertyDefault(String propertySetType,
                                            String propertySet,
                                            String propertyName)

Utility method for retrievng the default value from the PropertySet for the specified type, set, and name. This version will swallow any exceptions and return null if there is a problem looking up the property set manager. Other ConfigurableEntity classes can use this method to get default values in a reasonable safe way.

#### Parameters

propertySetType
  the property set type (e.g. USER, EVENT, REQUEST, SESSION).

propertySet
  the property set to look in

propertyName
  the name of the property

#### Returns

the default value of the property, or null if it was not defined

### getPropertyNoDefault(String, String) Method

    public abstract Object getPropertyNoDefault(String scopeName,
                                                String key)

Mimics the two argument `getPropertyNoDefault` method on the new `com.bea.p13n.property.ConfigurableEntity` interface.

#### Parameters

scopeName
  The name of the property set to look in

key
  The name of the property to retrieve.

#### Returns

the value for this property, or null if all searches failed

### getPropertySetManager() Method

    public static PropertySetManager getPropertySetManager()
         throws NamingException, CreateException, RemoteException, ClassCastException

Get a reference to the PropertySetManager session bean.

#### Exceptions

``NamingException``
``CreateException``
``RemoteException``
``ClassCastException``

### getUniqueId() Method

    public long getUniqueId()
         throws UnsupportedOperationException

This method is not supported.

#### Returns

this entity's unique id

#### Exceptions

``UnsupportedOperationException``

### removeProperty(String, String) Method

    public Object removeProperty(String aString,
                                 String aString2)
         throws UnsupportedOperationException

This method is not supported.

#### Parameters

aString
  The name of the property set.

aString2
  The name of the property to remove.

#### Returns

the old value of the property, or null if there was none.

#### Exceptions

``UnsupportedOperationException``

### setProperty(String, String, Object) Method

    public void setProperty(String aString,
                            String aString2,
                            Object anObject)
         throws UnsupportedOperationException

This method is not supported.

#### Parameters

aString
  The name of the property set.

aString2
  The name of the property to assign

anObject
  The value to associate with the property name

#### Exceptions

``UnsupportedOperationException``