Package org.glassfish.resources.api

Interface JavaEEResource

    • Method Detail

      • getResourceInfo

        ResourceInfo getResourceInfo()
        Resource Info. Immutable.
        Returns:

      • getType

        int getType()
        Resource type. Defined above. Immutable.
        Returns:

      • getProperties

        Set getProperties()
        Set containing elements of type ResourceProperty. Actual property names are resource type specific.
        Returns:
        Shallow copy of resource property set. If resource has 0 properties, empty set is returned.

      • addProperty

        void addProperty​(ResourceProperty property)
        Add a property. Underlying set is keyed by property name. The new property overrides any existing property with same name.
        Parameters:
        property -

      • removeProperty

        boolean removeProperty​(ResourceProperty property)
        Remove a property. Underlying set is keyed by property name.
        Parameters:
        property -
        Returns:
        true if property was removed, false if property was not found

      • getProperty

        ResourceProperty getProperty​(String propertyName)
        Get a property with the given name.
        Parameters:
        propertyName -
        Returns:
        ResourceProperty or null if not found.

      • makeClone

        JavaEEResource makeClone​(ResourceInfo resourceInfo)
        Create a new resource with the given name that has the same attribute and property settings as the invoked object.
        Parameters:
        resourceInfo -
        Returns:

      • setEnabled

        void setEnabled​(boolean value)
        Sets whether the resource is enabled.

        A resource can exist but be disabled, in which case references if an application is deployed that references it will deploy without errors, but when it is looked up a NamingException will be thrown

        Parameters:
        value -

      • isEnabled

        boolean isEnabled()
        Checks whether the resource is enabled.

        A resource can exist but be disabled, in which case references if an application is deployed that references it will deploy without errors, but when it is looked up a NamingException will be thrown

        Returns:

      • setDescription

        void setDescription​(String value)
        Sets description of the resource
        Parameters:
        value -

      • getDescription

        String getDescription()
        Gets description of the resource
        Returns: