Package com.inet.taskplanner.irc
Class IrcResultActionFactory
java.lang.Object
com.inet.taskplanner.server.api.common.AbstractFactory<COMPONENT,DEFINITION,INFO,SUMMARY>
com.inet.taskplanner.server.api.common.SeriesDependentFactory<T,com.inet.taskplanner.server.api.action.ResultActionDefinition,com.inet.taskplanner.server.api.action.ResultActionInfo,com.inet.taskplanner.server.api.common.SummaryInfo>
com.inet.taskplanner.server.api.action.ResultActionFactory<com.inet.taskplanner.irc.IrcResultAction>
com.inet.taskplanner.irc.IrcResultActionFactory
- All Implemented Interfaces:
com.inet.plugin.NamedExtension
public class IrcResultActionFactory
extends com.inet.taskplanner.server.api.action.ResultActionFactory<com.inet.taskplanner.irc.IrcResultAction>
The factory for an IRC task planner bot that send text results to an IRC channel
- Since:
- taskplanner 3.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The channel to be joined and the messages to be printed at.static final String
The nickname of the bot.static final String
Set server password, if requiredstatic final String
The port the IRC server is running at.static final String
The message that is printed in the quit notificationstatic final String
The real name of the connected botstatic final String
"true" if text results should be send to the channel, "false" if not (only the startmessage will be send)static final String
The hostname or ip of the IRC server to connect tostatic final String
"true" if the connection is encrypted, "false" if notstatic final String
A message that is printed to the IRC channel after connectingFields inherited from class com.inet.taskplanner.server.api.common.SeriesDependentFactory
PLACEHOLDER_END_CHARACTER, PLACEHOLDER_START_CHARACTER
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected com.inet.taskplanner.irc.IrcResultAction
createInstanceFrom
(com.inet.taskplanner.server.api.action.ResultActionDefinition definition, com.inet.id.GUID taskID) com.inet.taskplanner.server.api.action.ResultActionInfo
getInformation
(@Nullable com.inet.id.GUID taskID) com.inet.taskplanner.server.api.common.SummaryInfo
getSummary
(com.inet.taskplanner.server.api.action.ResultActionDefinition definition) List<com.inet.taskplanner.server.api.result.ResultFlavor>
getSupportedFlavors
(com.inet.taskplanner.server.api.action.ResultActionDefinition definition) protected void
validate
(com.inet.taskplanner.server.api.action.ResultActionDefinition definition, @Nullable com.inet.id.GUID taskID) Methods inherited from class com.inet.taskplanner.server.api.action.ResultActionFactory
hasPlaceholderSet, isAutoResolvePlaceholders
Methods inherited from class com.inet.taskplanner.server.api.common.SeriesDependentFactory
createFrom, getFirstValueFromSeries, patchDefinitionProperties, updateValues, updateValues, validate
Methods inherited from class com.inet.taskplanner.server.api.common.AbstractFactory
checkDefinitionArgument, createInstanceFrom, getExtensionName, isAvailable
-
Field Details
-
PROPERTY_SERVER
The hostname or ip of the IRC server to connect to- See Also:
-
PROPERTY_PORT
The port the IRC server is running at. Default is 6667.- See Also:
-
PROPERTY_SSL
"true" if the connection is encrypted, "false" if not- See Also:
-
PROPERTY_PASSWORD
Set server password, if required- See Also:
-
PROPERTY_NICKNAME
The nickname of the bot. Some servers limit them to 9 characters- See Also:
-
PROPERTY_REALNAME
The real name of the connected bot- See Also:
-
PROPERTY_CHANNEL
The channel to be joined and the messages to be printed at. Must start with '#'- See Also:
-
PROPERTY_STARTMESSAGE
A message that is printed to the IRC channel after connecting- See Also:
-
PROPERTY_QUITMESSAGE
The message that is printed in the quit notification- See Also:
-
PROPERTY_SENDRESULTS
"true" if text results should be send to the channel, "false" if not (only the startmessage will be send)- See Also:
-
-
Constructor Details
-
IrcResultActionFactory
public IrcResultActionFactory()Creates the factory for the IRC result action- Since:
- taskplanner 3.0
-
-
Method Details
-
getSupportedFlavors
public List<com.inet.taskplanner.server.api.result.ResultFlavor> getSupportedFlavors(com.inet.taskplanner.server.api.action.ResultActionDefinition definition) - Specified by:
getSupportedFlavors
in classcom.inet.taskplanner.server.api.action.ResultActionFactory<com.inet.taskplanner.irc.IrcResultAction>
-
getInformation
public com.inet.taskplanner.server.api.action.ResultActionInfo getInformation(@Nullable @Nullable com.inet.id.GUID taskID) - Specified by:
getInformation
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.taskplanner.irc.IrcResultAction,
com.inet.taskplanner.server.api.action.ResultActionDefinition, com.inet.taskplanner.server.api.action.ResultActionInfo, com.inet.taskplanner.server.api.common.SummaryInfo>
-
validate
protected void validate(com.inet.taskplanner.server.api.action.ResultActionDefinition definition, @Nullable @Nullable com.inet.id.GUID taskID) throws com.inet.taskplanner.server.api.error.ValidationException - Specified by:
validate
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.taskplanner.irc.IrcResultAction,
com.inet.taskplanner.server.api.action.ResultActionDefinition, com.inet.taskplanner.server.api.action.ResultActionInfo, com.inet.taskplanner.server.api.common.SummaryInfo> - Throws:
com.inet.taskplanner.server.api.error.ValidationException
-
createInstanceFrom
protected com.inet.taskplanner.irc.IrcResultAction createInstanceFrom(com.inet.taskplanner.server.api.action.ResultActionDefinition definition, com.inet.id.GUID taskID) - Overrides:
createInstanceFrom
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.taskplanner.irc.IrcResultAction,
com.inet.taskplanner.server.api.action.ResultActionDefinition, com.inet.taskplanner.server.api.action.ResultActionInfo, com.inet.taskplanner.server.api.common.SummaryInfo>
-
getSummary
public com.inet.taskplanner.server.api.common.SummaryInfo getSummary(com.inet.taskplanner.server.api.action.ResultActionDefinition definition) - Specified by:
getSummary
in classcom.inet.taskplanner.server.api.common.AbstractFactory<com.inet.taskplanner.irc.IrcResultAction,
com.inet.taskplanner.server.api.action.ResultActionDefinition, com.inet.taskplanner.server.api.action.ResultActionInfo, com.inet.taskplanner.server.api.common.SummaryInfo>
-