public class PluginDefinitionData extends CommonData implements RemovableData, AnnotatableData, RegisteredData
PluginDefinition
,
Developer documentation: Plug-ins, jobs and job agentsModifier and Type | Field and Description |
---|---|
private boolean |
allowImmediateExecution |
private AnnotationSetData |
annotationSet |
private java.lang.String |
className |
private java.util.Set<PluginConfigurationData> |
configurations |
private java.lang.String |
contact |
private java.lang.String |
copyright |
private java.lang.String |
description |
private boolean |
disabled |
private java.lang.String |
email |
private java.util.Date |
entryDate |
private java.util.Set<GuiContextData> |
guiContexts |
private boolean |
interactive |
private java.lang.String |
jarFile |
private java.util.Set<JobAgentSettingsData> |
jobAgentSettings |
private int |
mainType |
static int |
MAX_CLASSNAME_LENGTH
The maximum length of the class name that can be stored in the
database.
|
static int |
MAX_CONTACT_LENGTH
The maximum length of the contact information that can be stored in the
database.
|
static int |
MAX_COPYRIGHT_LENGTH
The maximum length of the copyright notice that can be stored in the
database.
|
static int |
MAX_DESCRIPTION_LENGTH
The maximum length of the url that can be stored in the
database.
|
static int |
MAX_EMAIL_LENGTH
The maximum length of the email address that can be stored in the
database.
|
static int |
MAX_JARFILE_LENGTH |
static int |
MAX_NAME_LENGTH
The maximum length of the name that can be stored in the
database.
|
static int |
MAX_URL_LENGTH
The maximum length of the url that can be stored in the
database.
|
static int |
MAX_VERSION_LENGTH
The maximum length of the version that can be stored in the
database.
|
private java.lang.Long |
maxMemory |
private java.lang.String |
name |
private java.util.Map<RoleKeyData,PluginPermission> |
permissions |
private java.util.Set<PluginTypeData> |
pluginTypes |
private boolean |
removed |
private boolean |
requiresConfiguration |
private boolean |
supportsConfigurations |
private boolean |
trusted |
private java.lang.String |
url |
private boolean |
useInternalJobQueue |
private boolean |
usePermissions |
private java.lang.String |
version |
Constructor and Description |
---|
PluginDefinitionData() |
Modifier and Type | Method and Description |
---|---|
boolean |
getAllowImmediateExecution()
If the plugin is allowed to be immediately executed or if it
must be added to the job queue.
|
java.util.Set<AnnotationLink> |
getAnnotations()
Short-cut to all annotations belonging to this item.
|
AnnotationSetData |
getAnnotationSet()
Get the annotation set that holds the annotations for an item.
|
java.lang.String |
getClassName()
Get the class name of the Java class that implements this plugin.
|
(package private) java.util.Set<PluginConfigurationData> |
getConfigurations()
This is the inverse end.
|
java.lang.String |
getContact()
Get contact information for the plugin.
|
java.lang.String |
getCopyright()
Get a copyright notice for the plugin.
|
java.lang.String |
getDescription()
Get a description of the plugin.
|
java.lang.String |
getEmail()
Get an email address that can be used to get more information about the plugin.
|
java.util.Date |
getEntryDate()
Get the date this item was added to the database.
|
java.util.Set<GuiContextData> |
getGuiContexts()
The item code for all items where it makes sense to use the
plugin in a client application.
|
java.lang.String |
getJarFile()
Get the file name of the JAR file where the plugin class is located.
|
(package private) java.util.Set<JobAgentSettingsData> |
getJobAgentSettings()
This is the inverse end.
|
int |
getMainType()
Get the main type of plugin.
|
java.lang.Long |
getMaxMemory()
The max amount of memory the plugin can use.
|
java.lang.String |
getName()
Get the name of the plugin.
|
java.util.Map<RoleKeyData,PluginPermission> |
getPermissions()
Get a map containing the rolekey and the permissions for this plugin.
|
java.util.Set<PluginTypeData> |
getPluginTypes()
The plugin types of this plugin, ie. all interfaces that it implements.
|
boolean |
getRequiresConfiguration()
If the plugin requires a configurations or not.
|
boolean |
getSupportsConfigurations()
If the plugin supports configurations or not.
|
java.lang.String |
getUrl()
Get a URL with more information about the plugin.
|
boolean |
getUseInternalJobQueue()
If the plug-in can be executed with the internal job queue or
not.
|
boolean |
getUsePermissions()
If the permissions for this plugin should be used or not.
|
java.lang.String |
getVersionString()
Get the version of the plugin.
|
boolean |
isDisabled()
If the plugin is enabled or disabled.
// Mapped in hibernate-properties-PluginDefinitionData.xml since annotation doesn't support a default value
|
boolean |
isInteractive()
If the plugin is interactive or not.
|
boolean |
isRemoved()
Check if the removed flag is set for this item.
|
boolean |
isTrusted()
If the plugin should be trusted or not.
|
void |
setAllowImmediateExecution(boolean allowImmediateExecution) |
(package private) void |
setAnnotations(java.util.Set<AnnotationLink> annotations) |
void |
setAnnotationSet(AnnotationSetData annotationSet)
Change the annotation set.
|
void |
setClassName(java.lang.String className) |
(package private) void |
setConfigurations(java.util.Set<PluginConfigurationData> configurations) |
void |
setContact(java.lang.String contact) |
void |
setCopyright(java.lang.String copyright) |
void |
setDescription(java.lang.String description)
Set the description for the item.
|
void |
setDisabled(boolean disabled) |
void |
setEmail(java.lang.String email) |
void |
setEntryDate(java.util.Date entryDate) |
(package private) void |
setGuiContexts(java.util.Set<GuiContextData> guiContexts) |
void |
setInteractive(boolean interactive) |
void |
setJarFile(java.lang.String jarFile) |
(package private) void |
setJobAgentSettings(java.util.Set<JobAgentSettingsData> jobAgentSettings) |
void |
setMainType(int mainType) |
void |
setMaxMemory(java.lang.Long maxMemory) |
void |
setName(java.lang.String name)
Set the name of the item.
|
(package private) void |
setPermissions(java.util.Map<RoleKeyData,PluginPermission> permissions) |
(package private) void |
setPluginTypes(java.util.Set<PluginTypeData> pluginTypes) |
void |
setRemoved(boolean removed)
Set the removed flag for this item.
|
void |
setRequiresConfiguration(boolean requiresConfiguration) |
void |
setSupportsConfigurations(boolean supportsConfigurations) |
void |
setTrusted(boolean trusted) |
void |
setUrl(java.lang.String url) |
void |
setUseInternalJobQueue(boolean useInternalJobQueue) |
void |
setUsePermissions(boolean usePermissions) |
void |
setVersionString(java.lang.String version) |
getItemKey, getProjectKey, setItemKey, setProjectKey
equals, getId, getVersion, hashCode, setId, setVersion, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getId, getVersion
getOwner, setOwner
private boolean removed
private AnnotationSetData annotationSet
private java.util.Date entryDate
public static final int MAX_CLASSNAME_LENGTH
private java.lang.String className
public static final int MAX_JARFILE_LENGTH
private java.lang.String jarFile
public static final int MAX_NAME_LENGTH
private java.lang.String name
public static final int MAX_DESCRIPTION_LENGTH
private java.lang.String description
public static final int MAX_VERSION_LENGTH
private java.lang.String version
public static final int MAX_COPYRIGHT_LENGTH
private java.lang.String copyright
public static final int MAX_CONTACT_LENGTH
private java.lang.String contact
public static final int MAX_EMAIL_LENGTH
private java.lang.String email
public static final int MAX_URL_LENGTH
private java.lang.String url
private int mainType
private boolean disabled
private boolean interactive
private boolean supportsConfigurations
private boolean requiresConfiguration
private boolean usePermissions
private java.util.Set<GuiContextData> guiContexts
private java.util.Set<PluginTypeData> pluginTypes
private java.util.Map<RoleKeyData,PluginPermission> permissions
private boolean trusted
private java.lang.Long maxMemory
private java.util.Set<JobAgentSettingsData> jobAgentSettings
private java.util.Set<PluginConfigurationData> configurations
private boolean allowImmediateExecution
private boolean useInternalJobQueue
public boolean isRemoved()
RemovableData
isRemoved
in interface RemovableData
isRemoved
in class CommonData
public void setRemoved(boolean removed)
RemovableData
setRemoved
in interface RemovableData
setRemoved
in class CommonData
removed
- TRUE if the item should be flagged as removed,
FALSE otherwisepublic AnnotationSetData getAnnotationSet()
AnnotatableData
getAnnotationSet
in interface AnnotatableData
AnnotationSetData
item or null if no annotations existpublic void setAnnotationSet(AnnotationSetData annotationSet)
AnnotatableData
setAnnotationSet
in interface AnnotatableData
annotationSet
- Annotation set to change to.public java.util.Set<AnnotationLink> getAnnotations()
AnnotatableData
getAnnotations
in interface AnnotatableData
void setAnnotations(java.util.Set<AnnotationLink> annotations)
public java.util.Date getEntryDate()
RegisteredData
getEntryDate
in interface RegisteredData
public void setEntryDate(java.util.Date entryDate)
public java.lang.String getClassName()
Plugin
interface.public void setClassName(java.lang.String className)
public java.lang.String getJarFile()
public void setJarFile(java.lang.String jarFile)
public java.lang.String getName()
getName
in interface NameableData
getName
in class CommonData
public void setName(java.lang.String name)
NameableData
MAX_NAME_LENGTH
constant.setName
in interface NameableData
setName
in class CommonData
name
- The new name for the itempublic java.lang.String getDescription()
getDescription
in interface NameableData
getDescription
in class CommonData
public void setDescription(java.lang.String description)
NameableData
MAX_DESCRIPTION_LENGTH
constant.setDescription
in interface NameableData
setDescription
in class CommonData
description
- The new description for the itempublic java.lang.String getVersionString()
public void setVersionString(java.lang.String version)
public java.lang.String getCopyright()
public void setCopyright(java.lang.String copyright)
public java.lang.String getContact()
public void setContact(java.lang.String contact)
public java.lang.String getEmail()
public void setEmail(java.lang.String email)
public java.lang.String getUrl()
public void setUrl(java.lang.String url)
public int getMainType()
Plugin.MainType
.public void setMainType(int mainType)
public boolean isDisabled()
public void setDisabled(boolean disabled)
public boolean isInteractive()
public void setInteractive(boolean interactive)
public boolean getSupportsConfigurations()
public void setSupportsConfigurations(boolean supportsConfigurations)
public boolean getRequiresConfiguration()
public void setRequiresConfiguration(boolean requiresConfiguration)
public boolean getUsePermissions()
public void setUsePermissions(boolean usePermissions)
public java.util.Set<GuiContextData> getGuiContexts()
void setGuiContexts(java.util.Set<GuiContextData> guiContexts)
public java.util.Set<PluginTypeData> getPluginTypes()
void setPluginTypes(java.util.Set<PluginTypeData> pluginTypes)
public java.util.Map<RoleKeyData,PluginPermission> getPermissions()
void setPermissions(java.util.Map<RoleKeyData,PluginPermission> permissions)
public boolean isTrusted()
public void setTrusted(boolean trusted)
public java.lang.Long getMaxMemory()
public void setMaxMemory(java.lang.Long maxMemory)
java.util.Set<JobAgentSettingsData> getJobAgentSettings()
JobAgentSettingsData.getPluginDefinition()
void setJobAgentSettings(java.util.Set<JobAgentSettingsData> jobAgentSettings)
java.util.Set<PluginConfigurationData> getConfigurations()
PluginConfigurationData.getPluginDefinition()
void setConfigurations(java.util.Set<PluginConfigurationData> configurations)
public boolean getAllowImmediateExecution()
public void setAllowImmediateExecution(boolean allowImmediateExecution)
public boolean getUseInternalJobQueue()
public void setUseInternalJobQueue(boolean useInternalJobQueue)