Package org.glassfish.resources.config

Interface CustomResource

All Superinterfaces:

BindableResource, ConfigBeanProxy, jakarta.validation.Payload, PropertyBag, Resource

@ResourceConfigCreator(commandName="create-custom-resource")
@ResourceTypeOrder(deploymentOrder=CUSTOM_RESOURCE)
@UniqueResourceNameConstraint(message="{resourcename.isnot.unique}",
                              payload=CustomResource.class)
public interface CustomResource
extends ConfigBeanProxy, Resource, PropertyBag, BindableResource

Custom (or generic) resource managed by a user-written factory class.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CustomResource.Duck

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the value of the description property.
String	getEnabled()	Gets the value of the enabled property.
@NotNull String	getFactoryClass()	Gets the value of the factoryClass property.
String	getIdentity()
List<Property>	getProperty()	Properties as per PropertyBag
@NotNull String	getResType()	Gets the value of the resType property.
void	setDescription(String value)	Sets the value of the description property.
void	setEnabled(String value)	Sets the value of the enabled property.
void	setFactoryClass(String value)	Sets the value of the factoryClass property.
void	setResType(String value)	Sets the value of the resType property.

Methods inherited from interface com.sun.enterprise.config.serverbeans.BindableResource

getJndiName, setJndiName

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

Methods inherited from interface com.sun.enterprise.config.serverbeans.Resource

getDeploymentOrder, getObjectType, setDeploymentOrder, setObjectType

Method Detail

getResType

@NotNull
@NotNull String getResType()

Gets the value of the resType property.

Returns:

possible object is String

setResType

void setResType(String value)
         throws PropertyVetoException

Sets the value of the resType property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getFactoryClass

@NotNull
@JavaClassName
@NotNull String getFactoryClass()

Gets the value of the factoryClass property.

Returns:

possible object is String

setFactoryClass

void setFactoryClass(String value)
              throws PropertyVetoException

Sets the value of the factoryClass property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getEnabled

String getEnabled()

Gets the value of the enabled property.

Specified by:

getEnabled in interface BindableResource

Returns:

possible object is String

setEnabled

void setEnabled(String value)
         throws PropertyVetoException

Sets the value of the enabled property.

Specified by:

setEnabled in interface BindableResource

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDescription

String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

void setDescription(String value)
             throws PropertyVetoException

Sets the value of the description property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getProperty

@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal props")
@PropertiesDesc(props={})
List<Property> getProperty()

Properties as per PropertyBag

Specified by:

getProperty in interface PropertyBag

Returns:

the property list

getIdentity

@DuckTyped
String getIdentity()

Specified by:

getIdentity in interface BindableResource

Specified by:

getIdentity in interface Resource