Package org.forum.client
Class QueryExecutorForum
java.lang.Object
org.forum.client.QueryExecutorForum
- All Implemented Interfaces:
GraphQLQueryExecutor
- Direct Known Subclasses:
Query
This class contains the methods that allows the execution of the queries or mutations that are defined in the Query of the GraphQL schema.
These methods allows:
These methods allows:
- Preparation of full requests
- Execution of prepared full requests
- Execution of direct full direct requests
- Preparation of partial requests
- Execution of prepared partial requests
- Execution of direct partial requests
- Author:
- generated by graphql-java-generator
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription__schema
(ObjectResponse objectResponse, Object... paramsAndValues) This method is expected by the graphql-java framework.This method executes a partial query on the __schema query against the GraphQL server.__schemaWithBindValues
(ObjectResponse objectResponse, Map<String, Object> parameters) This method is expected by the graphql-java framework.__schemaWithBindValues
(String queryResponseDef, Map<String, Object> parameters) This method executes a partial query on the __schema query against the GraphQL server.__type
(ObjectResponse objectResponse, String name, Object... paramsAndValues) This method is expected by the graphql-java framework.This method executes a partial query on the __type query against the GraphQL server.__typename
(ObjectResponse objectResponse, Object... paramsAndValues) This method is expected by the graphql-java framework.__typename
(String queryResponseDef, Object... paramsAndValues) This method executes a partial query on the __typename query against the GraphQL server.__typenameWithBindValues
(ObjectResponse objectResponse, Map<String, Object> parameters) This method is expected by the graphql-java framework.__typenameWithBindValues
(String queryResponseDef, Map<String, Object> parameters) This method executes a partial query on the __typename query against the GraphQL server.__typeWithBindValues
(ObjectResponse objectResponse, String name, Map<String, Object> parameters) This method is expected by the graphql-java framework.This method executes a partial query on the __type query against the GraphQL server.boards
(ObjectResponse objectResponse, Object... paramsAndValues) This method is expected by the graphql-java framework.This method executes a partial query on the boards query against the GraphQL server.boardsWithBindValues
(ObjectResponse objectResponse, Map<String, Object> parameters) This method is expected by the graphql-java framework.boardsWithBindValues
(String queryResponseDef, Map<String, Object> parameters) This method executes a partial query on the boards query against the GraphQL server.exec
(ObjectResponse objectResponse, Object... paramsAndValues) This method takes a full request definition, and executes it against the GraphQL server.This method takes a full request definition, and executes it against the GraphQL server.execWithBindValues
(ObjectResponse objectResponse, Map<String, Object> parameters) This method takes a full request definition, and executes it against the GraphQL server.execWithBindValues
(String queryResponseDef, Map<String, Object> parameters) This method takes a full request definition, and executes it against the GraphQL server.findTopics
(ObjectResponse objectResponse, String boardName, List<String> keyword, Object... paramsAndValues) This method is expected by the graphql-java framework.findTopics
(String queryResponseDef, String boardName, List<String> keyword, Object... paramsAndValues) This method executes a partial query on the findTopics query against the GraphQL server.findTopicsWithBindValues
(ObjectResponse objectResponse, String boardName, List<String> keyword, Map<String, Object> parameters) This method is expected by the graphql-java framework.findTopicsWithBindValues
(String queryResponseDef, String boardName, List<String> keyword, Map<String, Object> parameters) This method executes a partial query on the findTopics query against the GraphQL server.get__schemaGraphQLRequest
(String partialRequest) Get theGraphQLRequestForum
for the __schema EXECUTOR, created with the given Partial request.Get theBuilder
for the __Schema, as expected by the __schema query.get__typeGraphQLRequest
(String partialRequest) Get theGraphQLRequestForum
for the __type EXECUTOR, created with the given Partial request.get__typenameGraphQLRequest
(String partialRequest) Get theGraphQLRequestForum
for the __typename EXECUTOR, created with the given Partial request.Get theBuilder
for the String, as expected by the __typename query.Get theBuilder
for the __Type, as expected by the __type query.getBoardsGraphQLRequest
(String partialRequest) Get theGraphQLRequestForum
for the boards EXECUTOR, created with the given Partial request.Get theBuilder
for the Board, as expected by the boards query.getFindTopicsGraphQLRequest
(String partialRequest) Get theGraphQLRequestForum
for the findTopics EXECUTOR, created with the given Partial request.Get theBuilder
for the Topic, as expected by the findTopics query.getGraphQLRequest
(String fullRequest) Get theGraphQLRequestForum
for full request.getNbBoardsGraphQLRequest
(String partialRequest) Get theGraphQLRequestForum
for the nbBoards EXECUTOR, created with the given Partial request.Get theBuilder
for the Integer, as expected by the nbBoards query.Get theBuilder
for a full request, as expected by the exec and execWithBindValues methods.getTopicsGraphQLRequest
(String partialRequest) Get theGraphQLRequestForum
for the topics EXECUTOR, created with the given Partial request.Get theBuilder
for the Topic, as expected by the topics query.nbBoards
(ObjectResponse objectResponse, Object... paramsAndValues) This method is expected by the graphql-java framework.This method executes a partial query on the nbBoards query against the GraphQL server.nbBoardsWithBindValues
(ObjectResponse objectResponse, Map<String, Object> parameters) This method is expected by the graphql-java framework.nbBoardsWithBindValues
(String queryResponseDef, Map<String, Object> parameters) This method executes a partial query on the nbBoards query against the GraphQL server.topics
(ObjectResponse objectResponse, String boardName, Object... paramsAndValues) This method is expected by the graphql-java framework.This method executes a partial query on the topics query against the GraphQL server.topicsWithBindValues
(ObjectResponse objectResponse, String boardName, Map<String, Object> parameters) This method is expected by the graphql-java framework.This method executes a partial query on the topics query against the GraphQL server.
-
Constructor Details
-
QueryExecutorForum
public QueryExecutorForum()
-
-
Method Details
-
execWithBindValues
public QueryResponse execWithBindValues(String queryResponseDef, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method takes a full request definition, and executes it against the GraphQL server. As this class is a query executor, the provided request must be a query full request.
This method offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
Here is a sample on how to use it: This method takes a full request definition, and executes it against the GraphQL server. That is, the query contains the full string that follows the query keyword.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above). It must omit the query keyword, and start by the first { that follows. It may contain directives, as explained in the GraphQL specs.parameters
- The map of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
. The key is the parameter name, as declared in the request you defined (in the above sample: param is an optional parameter and skip is a mandatory one). The value is the parameter value in its Java type (for instance aDate
for theGraphQLScalarTypeDate
). The parameters which value is missing in this map will be ignored.- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
exec
public QueryResponse exec(String queryResponseDef, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method takes a full request definition, and executes it against the GraphQL server. As this class is a query executor, the provided request must be a query full request.
This method offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above). It must omit the query keyword, and start by the first { that follows. It may contain directives, as explained in the GraphQL specs.paramsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
execWithBindValues
public QueryResponse execWithBindValues(ObjectResponse objectResponse, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method takes a full request definition, and executes it against the GraphQL server. As this class is a query executor, the provided request must be a query full request.
This method offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
Here is a sample on how to use it:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by thegetGraphQLRequest(java.lang.String)
method or one of thegetXxxxGraphQLRequest(String)
methods.parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
exec
public QueryResponse exec(ObjectResponse objectResponse, Object... paramsAndValues) throws GraphQLRequestExecutionException This method takes a full request definition, and executes it against the GraphQL server. As this class is a query executor, the provided request must be a query full request.
This method offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
Here is a sample on how to use it:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by thegetGraphQLRequest(java.lang.String)
method or one of thegetXxxxGraphQLRequest(String)
paramsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
getResponseBuilder
Get theBuilder
for a full request, as expected by the exec and execWithBindValues methods.- Returns:
- Throws:
GraphQLRequestPreparationException
-
getGraphQLRequest
public GraphQLRequestForum getGraphQLRequest(String fullRequest) throws GraphQLRequestPreparationException Get theGraphQLRequestForum
for full request. For instance:GraphQLRequestForum request = new GraphQLRequest(fullRequest);
- Parameters:
fullRequest
- The full GraphQL Request, as specified in the GraphQL specification- Returns:
- Throws:
GraphQLRequestPreparationException
-
boardsWithBindValues
public List<Board> boardsWithBindValues(String queryResponseDef, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the boards query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of theboards
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
boards
public List<Board> boards(String queryResponseDef, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the boards query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of theboards
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
boardsWithBindValues
public List<Board> boardsWithBindValues(ObjectResponse objectResponse, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by thegetBoardsGraphQLRequest(java.lang.String)
method.parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
boards
public List<Board> boards(ObjectResponse objectResponse, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by thegetBoardsGraphQLRequest(java.lang.String)
method.paramsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
getBoardsResponseBuilder
Get theBuilder
for the Board, as expected by the boards query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
getBoardsGraphQLRequest
public GraphQLRequestForum getBoardsGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequestForum
for the boards EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-
nbBoardsWithBindValues
public Integer nbBoardsWithBindValues(String queryResponseDef, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the nbBoards query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thenbBoards
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
nbBoards
public Integer nbBoards(String queryResponseDef, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the nbBoards query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thenbBoards
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
nbBoardsWithBindValues
public Integer nbBoardsWithBindValues(ObjectResponse objectResponse, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by thegetNbBoardsGraphQLRequest(java.lang.String)
method.parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
nbBoards
public Integer nbBoards(ObjectResponse objectResponse, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by thegetNbBoardsGraphQLRequest(java.lang.String)
method.paramsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
getNbBoardsResponseBuilder
Get theBuilder
for the Integer, as expected by the nbBoards query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
getNbBoardsGraphQLRequest
public GraphQLRequestForum getNbBoardsGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequestForum
for the nbBoards EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-
topicsWithBindValues
public List<Topic> topicsWithBindValues(String queryResponseDef, String boardName, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the topics query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thetopics
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)boardName
- Parameter for the topics field of Query, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
topics
public List<Topic> topics(String queryResponseDef, String boardName, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the topics query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thetopics
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)boardName
- Parameter for the topics field of Query, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
topicsWithBindValues
public List<Topic> topicsWithBindValues(ObjectResponse objectResponse, String boardName, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by thegetTopicsGraphQLRequest(java.lang.String)
method.boardName
- Parameter for the topics field of Query, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
topics
public List<Topic> topics(ObjectResponse objectResponse, String boardName, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by thegetTopicsGraphQLRequest(java.lang.String)
method.boardName
- Parameter for the topics field of Query, as defined in the GraphQL schemaparamsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
getTopicsResponseBuilder
Get theBuilder
for the Topic, as expected by the topics query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
getTopicsGraphQLRequest
public GraphQLRequestForum getTopicsGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequestForum
for the topics EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-
findTopicsWithBindValues
public List<Topic> findTopicsWithBindValues(String queryResponseDef, String boardName, List<String> keyword, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the findTopics query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thefindTopics
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)boardName
- Parameter for the findTopics field of Query, as defined in the GraphQL schemakeyword
- Parameter for the findTopics field of Query, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
findTopics
public List<Topic> findTopics(String queryResponseDef, String boardName, List<String> keyword, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the findTopics query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of thefindTopics
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)boardName
- Parameter for the findTopics field of Query, as defined in the GraphQL schemakeyword
- Parameter for the findTopics field of Query, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
findTopicsWithBindValues
public List<Topic> findTopicsWithBindValues(ObjectResponse objectResponse, String boardName, List<String> keyword, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by thegetFindTopicsGraphQLRequest(java.lang.String)
method.boardName
- Parameter for the findTopics field of Query, as defined in the GraphQL schemakeyword
- Parameter for the findTopics field of Query, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
findTopics
public List<Topic> findTopics(ObjectResponse objectResponse, String boardName, List<String> keyword, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by thegetFindTopicsGraphQLRequest(java.lang.String)
method.boardName
- Parameter for the findTopics field of Query, as defined in the GraphQL schemakeyword
- Parameter for the findTopics field of Query, as defined in the GraphQL schemaparamsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
getFindTopicsResponseBuilder
Get theBuilder
for the Topic, as expected by the findTopics query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
getFindTopicsGraphQLRequest
public GraphQLRequestForum getFindTopicsGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequestForum
for the findTopics EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-
__schemaWithBindValues
public __Schema __schemaWithBindValues(String queryResponseDef, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the __schema query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of the__schema
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__schema
public __Schema __schema(String queryResponseDef, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the __schema query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of the__schema
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__schemaWithBindValues
public __Schema __schemaWithBindValues(ObjectResponse objectResponse, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by theget__schemaGraphQLRequest(java.lang.String)
method.parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__schema
public __Schema __schema(ObjectResponse objectResponse, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by theget__schemaGraphQLRequest(java.lang.String)
method.paramsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
get__schemaResponseBuilder
Get theBuilder
for the __Schema, as expected by the __schema query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
get__schemaGraphQLRequest
public GraphQLRequestForum get__schemaGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequestForum
for the __schema EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-
__typeWithBindValues
public __Type __typeWithBindValues(String queryResponseDef, String name, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the __type query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of the__type
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)name
- Parameter for the __type field of Query, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__type
public __Type __type(String queryResponseDef, String name, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the __type query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of the__type
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)name
- Parameter for the __type field of Query, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__typeWithBindValues
public __Type __typeWithBindValues(ObjectResponse objectResponse, String name, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by theget__typeGraphQLRequest(java.lang.String)
method.name
- Parameter for the __type field of Query, as defined in the GraphQL schemaparameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__type
public __Type __type(ObjectResponse objectResponse, String name, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by theget__typeGraphQLRequest(java.lang.String)
method.name
- Parameter for the __type field of Query, as defined in the GraphQL schemaparamsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
get__typeResponseBuilder
Get theBuilder
for the __Type, as expected by the __type query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
get__typeGraphQLRequest
public GraphQLRequestForum get__typeGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequestForum
for the __type EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-
__typenameWithBindValues
public String __typenameWithBindValues(String queryResponseDef, Map<String, Object> parameters) throws GraphQLRequestExecutionException, GraphQLRequestPreparationExceptionThis method executes a partial query on the __typename query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of the__typename
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__typename
public String __typename(String queryResponseDef, Object... paramsAndValues) throws GraphQLRequestExecutionException, GraphQLRequestPreparationException This method executes a partial query on the __typename query against the GraphQL server. That is, the query is one of the field of the Query type defined in the GraphQL schema. The queryResponseDef contains the part of the query that follows the field name.
It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method takes care of writing the query name, and the parameter(s) for the query. The given queryResponseDef describes the format of the response of the server response, that is the expected fields of the__typename
of the Query query type. It can be something like "{ id name }", or "" for a scalar. Please take a look at the StarWars, Forum and other samples for more complex queries.
Here is a sample on how to use it:- Parameters:
queryResponseDef
- The response definition of the query, in the native GraphQL format (see here above)parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestPreparationException
- When an error occurs during the request preparation, typically when building theObjectResponse
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__typenameWithBindValues
public String __typenameWithBindValues(ObjectResponse objectResponse, Map<String, Object> parameters) throws GraphQLRequestExecutionExceptionThis method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by theget__typenameGraphQLRequest(java.lang.String)
method.parameters
- The list of values, for the bind variables declared in the request you defined. If there is no bind variable in the defined Query, this argument may be null or an emptyMap
- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
__typename
public String __typename(ObjectResponse objectResponse, Object... paramsAndValues) throws GraphQLRequestExecutionException This method is expected by the graphql-java framework. It will be called when this query is called. It offers a logging of the call (if in debug mode), or of the call and its parameters (if in trace mode).
This method is valid for queries/mutations/subscriptions which don't have bind variables, as there is no parameters argument to pass the list of values.
Here is a sample:- Parameters:
objectResponse
- The definition of the response format, that describes what the GraphQL server is expected to return
Note: theObjectResponse
type of this parameter is defined for backward compatibility. In new implementations, the expected type is the generated GraphQLRequestForum POJO, as returned by theget__typenameGraphQLRequest(java.lang.String)
method.paramsAndValues
- This parameter contains all the name and values for the Bind Variables defined in the objectResponse parameter, that must be sent to the server. Optional parameter may not have a value. They will be ignored and not sent to the server. Mandatory parameter must be provided in this argument.
This parameter contains an even number of parameters: it must be a series of name and values : (paramName1, paramValue1, paramName2, paramValue2...)- Throws:
GraphQLRequestExecutionException
- When an error occurs during the request execution, typically a network error, an error from the GraphQL server or if the server response can't be parsed
-
get__typenameResponseBuilder
Get theBuilder
for the String, as expected by the __typename query.- Returns:
- Throws:
GraphQLRequestPreparationException
-
get__typenameGraphQLRequest
public GraphQLRequestForum get__typenameGraphQLRequest(String partialRequest) throws GraphQLRequestPreparationException Get theGraphQLRequestForum
for the __typename EXECUTOR, created with the given Partial request.- Parameters:
partialRequest
- The Partial GraphQL request, as explained in the plugin client documentation- Returns:
- Throws:
GraphQLRequestPreparationException
-