Public Member Functions |
Protected Member Functions |
Static Protected Member Functions |
Static Private Attributes |
List of all members
org.lightjason.agentspeak.action.builtin.web.rest.IBaseRest Class Referenceabstract
base class to read data from the restful service More...
Inheritance diagram for org.lightjason.agentspeak.action.builtin.web.rest.IBaseRest: Collaboration diagram for org.lightjason.agentspeak.action.builtin.web.rest.IBaseRest:Public Member Functions | |
| 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... | |
| Public Member Functions inherited from org.lightjason.agentspeak.language.execution.IExecution | |
| 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... | |
Protected Member Functions | |
| 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 | |
| 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 Private Attributes | |
| static final ObjectMapper | JSONMAPPER = new ObjectMapper() |
| json mapper More... | |
| static final long | serialVersionUID = -6606643839066144835L |
| serial id More... | |
| static final XmlMapper | XMLMAPPER = new XmlMapper() |
| xml mapper More... | |
Additional Inherited Members | |
| Public Attributes inherited from org.lightjason.agentspeak.action.IAction | |
| long | serialVersionUID = -6374480398439703170L |
| serial id 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
- Note
- all action which inherits this class uses the system property "http.agent" for defining the http user-agent
Definition at line 42 of file IBaseRest.java.
Constructor & Destructor Documentation
◆ IBaseRest()
|
protected |
- Parameters
-
p_length length
Definition at line 61 of file IBaseRest.java.
Member Function Documentation
◆ json()
|
staticprotected |
- Parameters
-
p_url url p_class convert class type
- Returns
- data object
- Exceptions
-
IOException is thrown on io errors
Definition at line 83 of file IBaseRest.java.
References org.lightjason.agentspeak.action.builtin.web.IBaseWeb.httpgetexecute().
Referenced by org.lightjason.agentspeak.action.builtin.web.rest.CJsonObject.execute(), and org.lightjason.agentspeak.action.builtin.web.rest.CJsonList.execute().
Here is the call graph for this function: Here is the caller graph for this function:◆ minimalArgumentNumber()
| final int org.lightjason.agentspeak.action.builtin.web.rest.IBaseRest.minimalArgumentNumber | ( | ) |
- Returns
- number of minimal arguments
Implements org.lightjason.agentspeak.action.IAction.
Definition at line 68 of file IBaseRest.java.
◆ xml()
|
staticprotected |
- Parameters
-
p_url url
- Returns
- map with xml data
- Exceptions
-
IOException is thrown on io errors
Definition at line 98 of file IBaseRest.java.
References org.lightjason.agentspeak.action.builtin.web.IBaseWeb.httpgetexecute().
Referenced by org.lightjason.agentspeak.action.builtin.web.rest.CXMLObject.execute().
Here is the call graph for this function: Here is the caller graph for this function:Member Data Documentation
◆ JSONMAPPER
|
staticprivate |
Definition at line 51 of file IBaseRest.java.
◆ serialVersionUID
|
staticprivate |
Definition at line 47 of file IBaseRest.java.
◆ XMLMAPPER
|
staticprivate |
Definition at line 55 of file IBaseRest.java.
