Package net.sf.basedb.core.data
Class PluginTypeData
java.lang.Object
net.sf.basedb.core.data.BasicData
net.sf.basedb.core.data.PluginTypeData
- All Implemented Interfaces:
IdentifiableData
,NameableData
,RegisteredData
,RemovableData
public class PluginTypeData extends BasicData implements NameableData, RemovableData, RegisteredData
This class represent an interface that a plugin can implement.
- Version:
- 2.0
- Author:
- Nicklas
- See Also:
PluginType
, Developer documentation: Plug-ins, jobs and job agents- Last modified
- $Date: 2015-11-17 13:57:57 +0100 (ti, 17 nov 2015) $
- Hibernate: class
- table="`PluginTypes`" lazy="false"
-
Field Summary
Fields Modifier and Type Field Description private String
description
private Date
entryDate
private String
interfaceName
private String
jarFile
static int
MAX_INTERFACENAME_LENGTH
The maximum length of the interface name that can be stored in the database.static int
MAX_JARFILE_LENGTH
private String
name
private Set<PluginDefinitionData>
plugins
private Integer
removedBy
Fields inherited from interface net.sf.basedb.core.data.NameableData
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
-
Constructor Summary
Constructors Constructor Description PluginTypeData()
-
Method Summary
Modifier and Type Method Description String
getDescription()
Get the description for the item.Date
getEntryDate()
Get the date this item was added to the database.String
getInterfaceName()
Get the interface name a plugin must implement to be of this type.String
getJarFile()
Get the file name of the JAR file where the plugin class is located.String
getName()
Get the name of the item.(package private) Set<PluginDefinitionData>
getPlugins()
The plugin implementing this interface.Integer
getRemovedBy()
Get the ID of the user that removed this item.void
setDescription(String description)
Set the description for the item.void
setEntryDate(Date entryDate)
void
setInterfaceName(String interfaceName)
void
setJarFile(String jarFile)
void
setName(String name)
Set the name of the item.(package private) void
setPlugins(Set<PluginDefinitionData> plugins)
void
setRemovedBy(Integer removedBy)
Set the ID of the user that removed this item or null to restore the item.Methods inherited from class net.sf.basedb.core.data.BasicData
equals, getId, getVersion, hashCode, setId, setVersion, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.basedb.core.data.IdentifiableData
getId, getVersion
-
Field Details
-
name
-
description
-
removedBy
-
entryDate
-
MAX_INTERFACENAME_LENGTH
public static final int MAX_INTERFACENAME_LENGTHThe maximum length of the interface name that can be stored in the database.- See Also:
- Constant Field Values
-
interfaceName
-
MAX_JARFILE_LENGTH
public static final int MAX_JARFILE_LENGTH- See Also:
- Constant Field Values
-
jarFile
-
plugins
-
-
Constructor Details
-
PluginTypeData
public PluginTypeData()
-
-
Method Details
-
getName
Description copied from interface:NameableData
Get the name of the item.- Specified by:
getName
in interfaceNameableData
- Returns:
- A
String
with the name of the item
-
setName
Description copied from interface:NameableData
Set the name of the item. The name cannot be null and mustn't be longer than the value specified by theMAX_NAME_LENGTH
constant.- Specified by:
setName
in interfaceNameableData
- Parameters:
name
- The new name for the item
-
getDescription
Description copied from interface:NameableData
Get the description for the item.- Specified by:
getDescription
in interfaceNameableData
- Returns:
- A
String
with a description of the item
-
setDescription
Description copied from interface:NameableData
Set the description for the item. The description can be null but mustn't be longer than the value specified by theMAX_DESCRIPTION_LENGTH
constant.- Specified by:
setDescription
in interfaceNameableData
- Parameters:
description
- The new description for the item
-
getRemovedBy
Description copied from interface:RemovableData
Get the ID of the user that removed this item.- Specified by:
getRemovedBy
in interfaceRemovableData
- Returns:
- The ID of a user or null if the item is not removed
-
setRemovedBy
Description copied from interface:RemovableData
Set the ID of the user that removed this item or null to restore the item.- Specified by:
setRemovedBy
in interfaceRemovableData
-
getEntryDate
Description copied from interface:RegisteredData
Get the date this item was added to the database. The value is generated at creation time and can't be modified later.- Specified by:
getEntryDate
in interfaceRegisteredData
-
setEntryDate
-
getInterfaceName
Get the interface name a plugin must implement to be of this type. The specified interface must extend thePlugin
interface.- Hibernate: property
- column="`interface_name`" type="string" length="255" not-null="true" unique="true"
-
setInterfaceName
-
getJarFile
Get the file name of the JAR file where the plugin class is located. The JAR file must be located in the 'plugins.dir' folder specified in base.config. If the value is null the plugin must be in the classpath (eg. WEB-INF/lib).- Returns:
- The class name for this plugin
- Since:
- 3.0
- Hibernate: property
- column="`jar_file`" type="string" length="255" not-null="false"
-
setJarFile
-
getPlugins
Set<PluginDefinitionData> getPlugins()The plugin implementing this interface. This is the inverse end.- See Also:
PluginDefinitionData.getPluginTypes()
- Hibernate: set
- table="`PluginDefinitionTypes`" lazy="true"
- Hibernate: collection-key
- column="`plugintype_id`"
- Hibernate: collection-many-to-many
- column="`plugindefinition_id`" class="net.sf.basedb.core.data.PluginDefinitionData"
-
setPlugins
-