|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PluginEnvironment
The root interface in the Plugin environment interface hierarchy.
This interface specifies methods that can be used by all Plugins. The getConfig*(String property) methods return the configured value for the given property, where * stands for the property type.
Nested Class Summary | |
---|---|
static interface |
PluginEnvironment.Host
Represents a host. |
Method Summary | |
---|---|
java.lang.Boolean |
getConfigBoolean(java.lang.String property)
Returns the value of the specified Boolean property. |
java.util.Date |
getConfigDate(java.lang.String property)
Returns the value of the specified Date property. |
java.lang.Double |
getConfigDouble(java.lang.String property)
Returns the value of the specified Double property. |
java.io.File |
getConfigFile(java.lang.String property)
Deprecated. no longer used, use String instead |
java.lang.Long |
getConfigLong(java.lang.String property)
Returns the value of the specified Long property. |
java.lang.String |
getConfigPassword(java.lang.String property)
Returns the value of the specified Password property. |
java.lang.String |
getConfigString(java.lang.String property)
Returns the value of the specified String or List property. |
java.net.URL |
getConfigUrl(java.lang.String property)
Returns the value of the specified URL property. |
PluginEnvironment.Host |
getHost()
Returns the host configured for the Plugin. |
boolean |
isStopped()
Returns whether the current execution should be stopped or not. |
Method Detail |
---|
java.lang.Boolean getConfigBoolean(java.lang.String property)
property
- the key of the property
java.util.Date getConfigDate(java.lang.String property)
property
- the key of the property
java.lang.Double getConfigDouble(java.lang.String property)
property
- the key of the property
@Deprecated java.io.File getConfigFile(java.lang.String property)
property
- the key of the property
java.lang.Long getConfigLong(java.lang.String property)
property
- the key of the property
java.lang.String getConfigString(java.lang.String property)
property
- the key of the property
java.lang.String getConfigPassword(java.lang.String property)
property
- the key of the property
PluginEnvironment.Host getHost()
java.net.URL getConfigUrl(java.lang.String property)
property
- the key of the property
boolean isStopped()
If this method returns true, Plugin execution should be stopped as soon as possible. If the Plugin ignores this or fails to stop execution in a reasonable time frame, the execution thread will be stopped ungracefully which might lead to resource leaks.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |