Class ComponentDefinitionImpl

    • Constructor Detail

      • ComponentDefinitionImpl

        public ComponentDefinitionImpl​(boolean isLicensed)
        Constructs a new ComponentDefinitionImpl instance.
        Parameters:
        isLicensed - Identifies the associated component as a Component requiring a license.
    • Method Detail

      • setId

        public void setId​(String id)
      • setName

        public void setName​(String name)
        Parameters:
        name -
      • setNameSpace

        @Deprecated
        public void setNameSpace​(String nameSpace)
        Deprecated.
        This method is deprecated. Use the setNameSpace on ComponentBundleDefinitionImpl instead.
      • getDescription

        public String getDescription()
        Return the language independent description of the component
        Specified by:
        getDescription in interface ComponentDefinition
        Returns:
        Language independent description of the component
      • setDescription

        public void setDescription​(String description)
        Set the language independent description of the component
        Parameters:
        secription - Language independent description of the component
      • isLicensed

        public final boolean isLicensed()
        Description copied from interface: ComponentDefinition
        Returns whether the Component requires a license or not.
        Specified by:
        isLicensed in interface ComponentDefinition
        Returns:
        If TRUE, the component requires a license to run in Web Manager.
      • getTypeId

        public String getTypeId()
        Description copied from interface: ComponentDefinition
        Returns the unique id for componentType of the component this componentDefinition describes.
        Specified by:
        getTypeId in interface ComponentDefinition
        Returns:
        the typeId
      • setTypeId

        public void setTypeId​(String typeId)
        Parameters:
        typeId -
      • getControllerClassName

        public String getControllerClassName()
        Description copied from interface: ComponentDefinition
        Returns the fully qualified className of the controlled class of the component this componentDefinition describes.
        Specified by:
        getControllerClassName in interface ComponentDefinition
        Returns:
        the className
      • setControllerClassName

        public void setControllerClassName​(String controllerClassName)
        Parameters:
        controllerClassName -
      • getInterfaceClassNames

        public String[] getInterfaceClassNames()
        Description copied from interface: ComponentDefinition
        Returns the array of fully qualified classNames of the published interfaces for the component this componentDefinition describes.
        Specified by:
        getInterfaceClassNames in interface ComponentDefinition
        Returns:
        an array of interfaceClassNames
      • setInterfaceClassNames

        public void setInterfaceClassNames​(String[] interfaceClassNames)
        Parameters:
        interfaceClassNames -
      • setImplementationClassName

        public void setImplementationClassName​(String implementationClassName)
        Parameters:
        implementationClassName -
      • getImplementationInstance

        public Object getImplementationInstance()
        Description copied from interface: ComponentDefinition
        Returns the instance of the implementing class of the component this ComponentDefinition describes. This is the instance of the service that is described by this component definition. This instance returns an implementation of the class with name ComponentDefinition.getImplementationClassName(), thus the class name of the object returned here equals, if not null, the implementation class name.
        Specified by:
        getImplementationInstance in interface ComponentDefinition
        Returns:
        The instance of the component
      • setImplementationInstance

        public void setImplementationInstance​(Object implementationInstance)
      • setDependencies

        public void setDependencies​(ComponentDependency[] dependencies)
        Parameters:
        dependencies -
      • getProperties

        public Dictionary<String,​String> getProperties()
        Description copied from interface: ComponentDefinition
        TODO rename to something like 'context' Returns a dictionary with additional properties for the component this componentDefinition describes.
        Specified by:
        getProperties in interface ComponentDefinition
        Returns:
        a dictionary of properties
      • setProperties

        public void setProperties​(Dictionary<String,​String> properties)
        Parameters:
        properties -
      • setNodeType

        public void setNodeType​(String nodeType)
        Setter for the node type assosiated with the component.
        Parameters:
        nodeType - The node type assosiated with the component.
      • getNodeType

        public String getNodeType()
        Description copied from interface: ComponentDefinition
        Returns the unique node type associated with the component.
        Specified by:
        getNodeType in interface ComponentDefinition
        Returns:
        the unique node type associated with the component
      • getInstanceClassName

        public String getInstanceClassName()
        Description copied from interface: ComponentDefinition
        Return the fully qualified className of the class returned by the getInstance method the component this componentDefinition describes.
        Specified by:
        getInstanceClassName in interface ComponentDefinition
        Returns:
        the className
      • setInstanceClassName

        public void setInstanceClassName​(String instanceClassName)
        Parameters:
        instanceClassName -
      • setWrapperClassNames

        public void setWrapperClassNames​(String[] wrapperClassNames)
        Parameters:
        wrapperClassNames -
      • setPermissionCategory

        public void setPermissionCategory​(PermissionCategory permissionCategory)
        Sets the permission category associated with the component.
        Parameters:
        permissionCategory - The permission category to set.
      • getPermissionsForPermissionGroups

        public Map<String,​Permission[]> getPermissionsForPermissionGroups()
        Description copied from interface: ComponentDefinition
        Returns a mapping that maps for each permission group which permissions used in this component should be assigned to that permission group. Permission groups are identified by a uniquely identifying string.
        Specified by:
        getPermissionsForPermissionGroups in interface ComponentDefinition
        Returns:
        a mapping that maps for each permission group which permissions used in this component should be assigned to that permission group
      • setPermissionsForPermissionGroup

        public void setPermissionsForPermissionGroup​(String permissionGroupValue,
                                                     Permission[] permissions)
        Put an array of permissions in a map using the uniquely identifying value of a permission group as a key. Note that this public method is not defined in the ComponentDefinition interface. This means you can only use this method when you still have access to this implementing class.
        Parameters:
        permissions - Array of permissions
        permissionGroupValue - Uniquely identifying value of a permission group
      • getLanguageResources

        public String[] getLanguageResources()
        Description copied from interface: ComponentDefinition
        Returns the names of the language resource files associated with this component
        Specified by:
        getLanguageResources in interface ComponentDefinition
        Returns:
        the names of the language resource files associated with this component
      • setLanguageResources

        public void setLanguageResources​(String[] languageResources)
        Parameters:
        languageResources -
      • getDisplayLanguage

        public String getDisplayLanguage​(String resourceName)
        Return the Java I18N display language assosiated with the resource file used by Spring.
        Specified by:
        getDisplayLanguage in interface ComponentDefinition
        Parameters:
        resourceName - Name of the resource file. Syntax of this file must be messages__.properties
        Returns:
        Java locale display language name assosiated with the resource.
      • getLanguageResourceMessage

        public String getLanguageResourceMessage​(String messageKey,
                                                 String languageResource)
        Returns the message with the given messagekey from the resourcebundle of the specified language.
        Specified by:
        getLanguageResourceMessage in interface ComponentDefinition
        Parameters:
        messageKey - bel to retrieve from the language resource
        languageResource - Language resource filename to retrieve message key from
        Returns:
        nameValuePair with the label and values of the specified language label and language
      • getLanguageResourceMessages

        public HashMap<String,​HashMap<String,​String>> getLanguageResourceMessages()
        Returns a hashtable of loaded languageResources. Maps the name of the language resources onto a Hashmage containing the messageKeys and messageValues of the languageresource. if the languageResources where not loaded, it will be.
        Specified by:
        getLanguageResourceMessages in interface ComponentDefinition
        Returns:
        a hashtable which maps the name of all available languageresources onto a Hashmage containing the messageKeys and messageValues of the languageresource.
      • setEntityFactoryClassName

        public void setEntityFactoryClassName​(String entityFactoryClassName)
        Set the name of the EntityFactory class to use for handling persistence.
        Parameters:
        entityFactoryClassName -
      • setPersistenceManagerClassName

        public void setPersistenceManagerClassName​(String persistenceManagerClassName)
        Set the name of the PersistenceManager class to use for handling persistence.
        Parameters:
        persistenceManagerClassName -
      • getEntityClassNames

        public String[] getEntityClassNames()
        Description copied from interface: ComponentDefinition
        Gets the list of classNames that should be handled by the EntityFactory and PersisitenceManager.
        Specified by:
        getEntityClassNames in interface ComponentDefinition
        Returns:
        an Array containing names of Entity classes
      • setEntityClassNames

        public void setEntityClassNames​(String[] entityClassnames)
        Sets the names of entity classes handled by the EntityFactory and the PersistenceManager.
        Parameters:
        entityClassnames - the names of entity classes to be handled by the EntityFactory and the PersistenceManager