Package jmri.jmrit.logixng.actions
Class WebRequest
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.jmrit.logixng.implementation.AbstractBase
-
- jmri.jmrit.logixng.actions.AbstractDigitalAction
-
- jmri.jmrit.logixng.actions.WebRequest
-
- All Implemented Interfaces:
java.beans.PropertyChangeListener
,java.beans.VetoableChangeListener
,java.lang.Comparable<NamedBean>
,java.util.EventListener
,PropertyChangeProvider
,Base
,DigitalAction
,DigitalActionBean
,FemaleSocketListener
,NamedBean
public class WebRequest extends AbstractDigitalAction implements FemaleSocketListener, java.beans.PropertyChangeListener, java.beans.VetoableChangeListener
This action sends a web request.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WebRequest.Parameter
static class
WebRequest.ReplyType
static class
WebRequest.RequestMethodType
-
Nested classes/interfaces inherited from interface jmri.jmrit.logixng.Base
Base.PrintTreeSettings, Base.RunnableWithBase, Base.RunnableWithBaseThrowException
-
Nested classes/interfaces inherited from interface jmri.NamedBean
NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_USER_AGENT
-
Fields inherited from class jmri.jmrit.logixng.implementation.AbstractBase
_listenersAreRegistered
-
Fields inherited from class jmri.implementation.AbstractNamedBean
listenerRefs, mSystemName, register
-
Fields inherited from interface jmri.jmrit.logixng.Base
PRINT_LINE_NUMBERS_FORMAT, PROPERTY_CHILD_COUNT, PROPERTY_CHILD_REORDER, PROPERTY_LAST_RESULT_CHANGED, PROPERTY_SOCKET_CONNECTED, PROPERTY_SOCKET_DISCONNECTED, SEPARATOR, SOCKET_CONNECTED, SOCKET_DISCONNECTED
-
Fields inherited from interface jmri.NamedBean
DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN
-
-
Constructor Summary
Constructors Constructor Description WebRequest(java.lang.String sys, java.lang.String user)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
connected(FemaleSocket socket)
The socket is connected.void
disconnected(FemaleSocket socket)
The socket is disconnected.void
disposeMe()
Dispose this class.void
execute()
Execute this DigitalActionBean.Category
getCategory()
Get the category.FemaleSocket
getChild(int index)
Get a child of this itemint
getChildCount()
Get the number of children.Base
getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames)
Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used.java.lang.String
getLocalVariableForCookies()
java.lang.String
getLocalVariableForReplyContent()
java.lang.String
getLocalVariableForResponseCode()
java.lang.String
getLongDescription(java.util.Locale locale)
Get a long description of this item.java.util.List<WebRequest.Parameter>
getParameters()
LogixNG_SelectCharset
getSelectCharset()
LogixNG_SelectEnum<LineEnding>
getSelectLineEnding()
LogixNG_SelectEnum<WebRequest.ReplyType>
getSelectReplyType()
LogixNG_SelectEnum<WebRequest.RequestMethodType>
getSelectRequestMethod()
LogixNG_SelectString
getSelectUrl()
LogixNG_SelectString
getSelectUserAgent()
java.lang.String
getShortDescription(java.util.Locale locale)
Get a short description of this item.FemaleDigitalActionSocket
getSocket()
java.lang.String
getSocketSystemName()
void
getUsageDetail(int level, NamedBean bean, java.util.List<NamedBeanUsageReport> report, NamedBean cdl)
Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.void
propertyChange(java.beans.PropertyChangeEvent evt)
void
registerListenersForThisClass()
Register listeners if this object needs that.void
setLocalVariableForCookies(java.lang.String localVariable)
void
setLocalVariableForReplyContent(java.lang.String localVariable)
void
setLocalVariableForResponseCode(java.lang.String localVariable)
void
setSocketSystemName(java.lang.String systemName)
void
setup()
Setup this object and its children.void
unregisterListenersForThisClass()
Unregister listeners if this object needs that.-
Methods inherited from class jmri.jmrit.logixng.actions.AbstractDigitalAction
getBeanType, getNewSocketName, getNewSocketName, getParent, getPreferredSocketPrefix, getState, setParent, setState
-
Methods inherited from class jmri.jmrit.logixng.implementation.AbstractBase
assertListenersAreNotRegistered, compareSystemNameSuffix, deepCopyChildren, dispose, getConditionalNG, getListenerRefsIncludingChildren, getLogixNG, getRoot, getUsageTree, isActive, printTree, printTree, printTree, printTreeRow, registerListeners, setParentForAllChildren, unregisterListeners
-
Methods inherited from class jmri.implementation.AbstractNamedBean
addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, describeState, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface jmri.jmrit.logixng.Base
addPropertyChangeListener, addPropertyChangeListener, deepCopyChildren, dispose, doSocketOperation, existsInTree, forEntireTree, forEntireTreeWithException, getComment, getConditionalNG, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageTree, getUserName, hasChild, isActive, isEnabled, isSocketOperationAllowed, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.jmrit.logixng.FemaleSocketListener
socketNameChanged
-
Methods inherited from interface jmri.NamedBean
addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Field Detail
-
DEFAULT_USER_AGENT
public static final java.lang.String DEFAULT_USER_AGENT
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
WebRequest
public WebRequest(java.lang.String sys, java.lang.String user) throws NamedBean.BadUserNameException, NamedBean.BadSystemNameException
-
-
Method Detail
-
getDeepCopy
public Base getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames) throws ParserException, JmriException
Description copied from interface:Base
Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used. If no user name is given, a null user name is used.- Specified by:
getDeepCopy
in interfaceBase
- Parameters:
systemNames
- a map of old and new system nameuserNames
- a map of old system name and new user name- Returns:
- a deep copy
- Throws:
JmriException
- in case of an errorParserException
-
getSelectUrl
public LogixNG_SelectString getSelectUrl()
-
getSelectCharset
public LogixNG_SelectCharset getSelectCharset()
-
getSelectRequestMethod
public LogixNG_SelectEnum<WebRequest.RequestMethodType> getSelectRequestMethod()
-
getSelectUserAgent
public LogixNG_SelectString getSelectUserAgent()
-
getSelectReplyType
public LogixNG_SelectEnum<WebRequest.ReplyType> getSelectReplyType()
-
getSelectLineEnding
public LogixNG_SelectEnum<LineEnding> getSelectLineEnding()
-
getParameters
public java.util.List<WebRequest.Parameter> getParameters()
-
setLocalVariableForResponseCode
public void setLocalVariableForResponseCode(java.lang.String localVariable)
-
getLocalVariableForResponseCode
public java.lang.String getLocalVariableForResponseCode()
-
setLocalVariableForReplyContent
public void setLocalVariableForReplyContent(java.lang.String localVariable)
-
getLocalVariableForReplyContent
public java.lang.String getLocalVariableForReplyContent()
-
setLocalVariableForCookies
public void setLocalVariableForCookies(java.lang.String localVariable)
-
getLocalVariableForCookies
public java.lang.String getLocalVariableForCookies()
-
getCategory
public Category getCategory()
Get the category.- Specified by:
getCategory
in interfaceBase
- Overrides:
getCategory
in classAbstractBase
- Returns:
- the category
-
execute
public void execute() throws JmriException
Execute this DigitalActionBean.- Specified by:
execute
in interfaceDigitalAction
- Throws:
JmriException
- when an exception occurs
-
getChild
public FemaleSocket getChild(int index) throws java.lang.IllegalArgumentException, java.lang.UnsupportedOperationException
Description copied from class:AbstractBase
Get a child of this item- Specified by:
getChild
in interfaceBase
- Overrides:
getChild
in classAbstractBase
- Parameters:
index
- the index of the child to get- Returns:
- the child
- Throws:
java.lang.IllegalArgumentException
- if the index is less than 0 or greater or equal with the value returned by getChildCount()java.lang.UnsupportedOperationException
-
getChildCount
public int getChildCount()
Description copied from class:AbstractBase
Get the number of children.- Specified by:
getChildCount
in interfaceBase
- Overrides:
getChildCount
in classAbstractBase
- Returns:
- the number of children
-
connected
public void connected(FemaleSocket socket)
Description copied from interface:FemaleSocketListener
The socket is connected.- Specified by:
connected
in interfaceFemaleSocketListener
- Parameters:
socket
- the socket
-
disconnected
public void disconnected(FemaleSocket socket)
Description copied from interface:FemaleSocketListener
The socket is disconnected.- Specified by:
disconnected
in interfaceFemaleSocketListener
- Parameters:
socket
- the socket
-
getShortDescription
public java.lang.String getShortDescription(java.util.Locale locale)
Description copied from interface:Base
Get a short description of this item.- Specified by:
getShortDescription
in interfaceBase
- Parameters:
locale
- The locale to be used- Returns:
- a short description
-
getLongDescription
public java.lang.String getLongDescription(java.util.Locale locale)
Description copied from interface:Base
Get a long description of this item.- Specified by:
getLongDescription
in interfaceBase
- Parameters:
locale
- The locale to be used- Returns:
- a long description
-
getSocket
public FemaleDigitalActionSocket getSocket()
-
getSocketSystemName
public java.lang.String getSocketSystemName()
-
setSocketSystemName
public void setSocketSystemName(java.lang.String systemName)
-
setup
public void setup()
Setup this object and its children. This method is used to lookup system names for child sockets, turnouts, sensors, and so on.
-
registerListenersForThisClass
public void registerListenersForThisClass()
Register listeners if this object needs that.Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not registered more than once.
- Overrides:
registerListenersForThisClass
in classAbstractBase
-
unregisterListenersForThisClass
public void unregisterListenersForThisClass()
Unregister listeners if this object needs that.Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not unregistered more than once.
- Overrides:
unregisterListenersForThisClass
in classAbstractBase
-
propertyChange
public void propertyChange(java.beans.PropertyChangeEvent evt)
- Specified by:
propertyChange
in interfacejava.beans.PropertyChangeListener
-
disposeMe
public void disposeMe()
Dispose this class. Listeners do not need to be unregistered by this method since they are unregistered by dispose().- Overrides:
disposeMe
in classAbstractBase
-
getUsageDetail
public void getUsageDetail(int level, NamedBean bean, java.util.List<NamedBeanUsageReport> report, NamedBean cdl)
Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.NamedBeanUsageReport Usage keys:
- LogixNGAction
- LogixNGExpression
- Specified by:
getUsageDetail
in interfaceBase
- Overrides:
getUsageDetail
in classAbstractBase
- Parameters:
level
- The current recursion level for debugging.bean
- The named bean that is the object of the search.report
- A list of NamedBeanUsageReport usage reports.cdl
- The current ConditionalNG bean. Null for Module searches since there is no conditional
-
-