org.lightjason.agentspeak.action.builtin.web.rest.CXMLObject Class Reference
action to call a restful webservice with XML data. More...
Inheritance diagram for org.lightjason.agentspeak.action.builtin.web.rest.CXMLObject: Collaboration diagram for org.lightjason.agentspeak.action.builtin.web.rest.CXMLObject:Public Member Functions | |
| CXMLObject () | |
| ctor More... | |
| final IFuzzyValue< Boolean > | execute (final boolean p_parallel, @Nonnull final IContext p_context, @Nonnull final List< ITerm > p_argument, @Nonnull final List< ITerm > p_return) |
| defines a plan-body operation More... | |
| Public Member Functions inherited from org.lightjason.agentspeak.action.builtin.web.rest.IBaseRest | |
| final int | minimalArgumentNumber () |
| minimum number of arguments More... | |
| Public Member Functions inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction | |
| final IPath | name () |
| returns the name with path of the action More... | |
| Public Member Functions inherited from org.lightjason.agentspeak.action.IBaseAction | |
| final boolean | equals (final Object p_object) |
| final int | hashCode () |
| final String | toString () |
| Public Member Functions inherited from org.lightjason.agentspeak.action.IAction | |
| default Stream< IVariable<?> > | variables () |
| returns a stream with all used variables More... | |
Static Private Attributes | |
| static final long | serialVersionUID = 8156192343303737293L |
| serial id More... | |
Additional Inherited Members | |
| Public Attributes inherited from org.lightjason.agentspeak.action.IAction | |
| long | serialVersionUID = -6374480398439703170L |
| serial id More... | |
| Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.web.rest.IBaseRest | |
| IBaseRest (final int p_length) | |
| ctor More... | |
| Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.web.IBaseWeb | |
| IBaseWeb (final int p_length) | |
| ctor More... | |
| Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction | |
| IBuiltinAction () | |
| ctor More... | |
| IBuiltinAction (final int p_length) | |
| ctor More... | |
| Static Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.web.rest.IBaseRest | |
| static< T > T | json ( @Nonnull final String p_url, @Nonnull final Class< T > p_class) throws IOException |
| reads a json structure from an url More... | |
| static Map< String, ?> | xml ( @Nonnull final String p_url) throws IOException |
| reads a xml structure from an url More... | |
| Static Protected Member Functions inherited from org.lightjason.agentspeak.action.builtin.web.IBaseWeb | |
| static ITerm | baseliteral ( @Nonnull final Stream< String > p_functor, @Nonnull final Stream< ITerm > p_values) |
| creates a literal structure from a stream of string elements, the string stream will be build in a tree structure More... | |
| static Stream< ITerm > | flatterm ( @Nullable final Object p_object) |
| converts an object into a term stream More... | |
| static HttpGet | httpget ( @Nonnull final String p_url) |
| returns a http-get connection More... | |
| static String | httpgetexecute ( @Nonnull final String p_url) throws IOException |
| execute http-get request More... | |
| static String | httpgetexecute ( @Nonnull final HttpGet p_get) throws IOException |
| execute http-get request More... | |
| static HttpPost | httppost ( @Nonnull final String p_url) |
| returns a http-post connection More... | |
| static String | httppostexecute ( @Nonnull final HttpPost p_post) throws IOException |
| execute http-post request More... | |
| Static Protected Attributes inherited from org.lightjason.agentspeak.action.builtin.IBuiltinAction | |
| static final Logger | LOGGER = CCommon.logger( IBuiltinAction.class ) |
| logger More... | |
| Static Protected Attributes inherited from org.lightjason.agentspeak.action.IBaseAction | |
| static final Logger | LOGGER = org.lightjason.agentspeak.common.CCommon.logger( IAction.class ) |
| logger More... | |
Detailed Description
Creates a literal from an XML REST-webservice, first argument is the URL of the webservice and second argument the functor of the literal
W = web/rest/xmlobject( "https://en.wikipedia.org/wiki/Special:Export/AgentSpeak", "wikipedia" );
- See also
- https://en.wikipedia.org/wiki/Representational_state_transfer
- https://en.wikipedia.org/wiki/Web_service
- https://en.wikipedia.org/wiki/XML
Definition at line 48 of file CXMLObject.java.
Constructor & Destructor Documentation
◆ CXMLObject()
| org.lightjason.agentspeak.action.builtin.web.rest.CXMLObject.CXMLObject | ( | ) |
Definition at line 58 of file CXMLObject.java.
Member Function Documentation
◆ execute()
| final IFuzzyValue<Boolean> org.lightjason.agentspeak.action.builtin.web.rest.CXMLObject.execute | ( | final boolean | p_parallel, |
| @Nonnull final IContext | p_context, | ||
| @Nonnull final List< ITerm > | p_argument, | ||
| @Nonnull final List< ITerm > | p_return | ||
| ) |
- Parameters
-
p_parallel parallel execution p_context current execution context p_argument parameter of the action p_return return values
- Returns
- fuzzy boolean
Implements org.lightjason.agentspeak.language.execution.IExecution.
Definition at line 65 of file CXMLObject.java.
References org.lightjason.agentspeak.action.builtin.web.IBaseWeb.baseliteral(), org.lightjason.agentspeak.action.builtin.web.IBaseWeb.flatterm(), org.lightjason.agentspeak.language.fuzzy.CFuzzyValue< T >.from(), org.lightjason.agentspeak.language.CLiteral.from(), and org.lightjason.agentspeak.action.builtin.web.rest.IBaseRest.xml().
Referenced by org.lightjason.agentspeak.action.builtin.TestCActionWebRest.xmlobjectmultiple(), and org.lightjason.agentspeak.action.builtin.TestCActionWebRest.xmlobjectsingle().
Here is the call graph for this function: Here is the caller graph for this function:Member Data Documentation
◆ serialVersionUID
|
staticprivate |
Definition at line 53 of file CXMLObject.java.
