LightJason - AgentSpeak(L++)
org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL Class Referenceabstract

base graphql access More...

+ Inheritance diagram for org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL:
+ Collaboration diagram for org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL:

Public Member Functions

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...
 
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...
 

Protected Member Functions

 IBaseGraphQL (final int p_length)
 ctor More...
 
abstract String argumentquery ( @Nonnull final ITerm p_argument)
 convert argument into graphql query 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 Stream< ITermsendquery ( @Nonnull final String p_url, @Nonnull final String p_query) throws IOException
 executes graphql query and returns a stream of terms of the result 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< ITermflatterm ( @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

static final ObjectMapper JSONMAPPER = new ObjectMapper()
 json mapper 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...
 

Private Member Functions

String query ( @Nonnull final ITerm p_argument)
 converts a term argument to a graphql query More...
 

Static Private Attributes

static final long serialVersionUID = -4140550516932255685L
 serial id More...
 

Additional Inherited Members

- Public Attributes inherited from org.lightjason.agentspeak.action.IAction
long serialVersionUID = -6374480398439703170L
 serial id More...
 

Detailed Description

Definition at line 51 of file IBaseGraphQL.java.

Constructor & Destructor Documentation

◆ IBaseGraphQL()

org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.IBaseGraphQL ( final int  p_length)
protected
Parameters
p_lengthlength

Definition at line 68 of file IBaseGraphQL.java.

Member Function Documentation

◆ argumentquery()

abstract String org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.argumentquery ( @Nonnull final ITerm  p_argument)
abstractprotected
Parameters
p_argumentquery argument
Returns
query string

Referenced by org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.query().

+ Here is the caller graph for this function:

◆ execute()

final IFuzzyValue<Boolean> org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.execute ( final boolean  p_parallel,
@Nonnull final IContext  p_context,
@Nonnull final List< ITerm p_argument,
@Nonnull final List< ITerm p_return 
)
Parameters
p_parallelparallel execution
p_contextcurrent execution context
p_argumentparameter of the action
p_returnreturn values
Returns
fuzzy boolean

Implements org.lightjason.agentspeak.language.execution.IExecution.

Definition at line 98 of file IBaseGraphQL.java.

References org.lightjason.agentspeak.action.builtin.web.IBaseWeb.baseliteral(), org.lightjason.agentspeak.language.CCommon.flatten(), org.lightjason.agentspeak.language.fuzzy.CFuzzyValue< T >.from(), org.lightjason.agentspeak.language.CLiteral.from(), org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.query(), and org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.sendquery().

+ Here is the call graph for this function:

◆ minimalArgumentNumber()

final int org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.minimalArgumentNumber ( )
Returns
number of minimal arguments

Implements org.lightjason.agentspeak.action.IAction.

Definition at line 74 of file IBaseGraphQL.java.

◆ query()

String org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.query ( @Nonnull final ITerm  p_argument)
private
Parameters
p_argumentquery argument
Returns
graphql query
Note
query must be encapsulate as string in a json object with key query

Definition at line 132 of file IBaseGraphQL.java.

References org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.argumentquery().

Referenced by org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.execute().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sendquery()

static Stream<ITerm> org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.sendquery ( @Nonnull final String  p_url,
@Nonnull final String  p_query 
) throws IOException
staticprotected
Parameters
p_urlendpoint url
p_queryquery
Returns
result literal stream
Exceptions
IOExceptionis thrown on parsing and connection errors

Definition at line 87 of file IBaseGraphQL.java.

References org.lightjason.agentspeak.action.builtin.web.IBaseWeb.flatterm(), org.lightjason.agentspeak.action.builtin.web.IBaseWeb.httppost(), and org.lightjason.agentspeak.action.builtin.web.IBaseWeb.httppostexecute().

Referenced by org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.execute().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ JSONMAPPER

final ObjectMapper org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.JSONMAPPER = new ObjectMapper()
staticprotected

Definition at line 56 of file IBaseGraphQL.java.

◆ serialVersionUID

final long org.lightjason.agentspeak.action.builtin.web.graphql.IBaseGraphQL.serialVersionUID = -4140550516932255685L
staticprivate

Definition at line 60 of file IBaseGraphQL.java.