Class IntegrationPoint
- java.lang.Object
-
- org.glassfish.admingui.connector.IntegrationPoint
-
- All Implemented Interfaces:
Serializable
public class IntegrationPoint extends Object implements Serializable
An
IntegrationPoint
represents the data necessary to describe a particular integration point into the admin console. Some examples of integration points include:- Add a TreeNode to the navigation tree
- Add a HelpContent to the application
- Add initialization logic to execute when a user logins into the application
- Add content to a specific page within the application
The design of this data structure is intentionally very general so that this data structure can be applied to a wide range of situations. It also intentionally does not refer to gui concepts such as "tree" or other UI elements so that these concepts be independent of this data as much as possible. This will allow some flexibility by the consumer of this data to render it in an appropriate way (to some extent). This will however, be limited by the content of the data this structure refers to (if any).
The
IntegrationPoint
contains the following properties:type
- (required) A String specifying the integration type.parentId
- The parentIntegrationPoint
's id.priority
- A priority of this component, often used to compare or sortIntegrationPoint
s.providerId
- TheConsoleProvider
's id which provided thisIntegrationPoint
.content
- A value pointing to additional content to implement thisIntegrationPoint
handlerId
- AnHandler
name which should be invoked to help implement thisIntegrationPoint
id
- A value used to identify this specific integration point.
All values in this class are immutable.
- Author:
- Ken Paulsen ([email protected])
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description IntegrationPoint()
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getConsoleConfigId()
This provides access to theConsoleConfig
which provided thisIntegrationPoint
.String
getContent()
A reference to extra information needed to use thisIntegrationPoint
.String
getId()
The identifier of thisIntegrationPoint
.String
getParentId()
The parent identifier.int
getPriority()
This specifies the relative priority of thisIntegrationPoint
.String
getType()
This specifies the type of thisIntegrationPoint
.void
setConsoleConfigId(String id)
This method should only be called by theConsolePluginService
.String
toString()
Overrides the toString() method.
-
-
-
Method Detail
-
getId
public String getId()
The identifier of this
IntegrationPoint
.
-
getType
public String getType()
This specifies the type of this
IntegrationPoint
. The type might specify that this integration is a "navigation" integration, "help" integration, "applicationPage" integration, or any other supported integration type.
-
getParentId
public String getParentId()
The parent identifier. Useful when an
IntegrationPoint
needs to refer to another integration point (such as when specifying which TreeNode to fall under.
-
getContent
public String getContent()
A reference to extra information needed to use this
IntegrationPoint
. An example might be a .jsf page reference which should be included. Or a location used to find HelpSet information.
-
getPriority
public int getPriority()
This specifies the relative priority of this
IntegrationPoint
. This may be used for sorting multipleIntegrationPoints
, or for other implementation-specific purposes.
-
toString
public String toString()
Overrides the toString() method.
-
getConsoleConfigId
public String getConsoleConfigId()
This provides access to the
ConsoleConfig
which provided thisIntegrationPoint
.
-
setConsoleConfigId
public void setConsoleConfigId(String id)
This method should only be called by the
ConsolePluginService
. This associates thisIntegrationPoint
with theConsoleConfig
which specified it.
-
-