org.opencode4workspace.endpoints

Class AbstractWWGraphQLEndpoint

java.lang.Object

org.opencode4workspace.endpoints.AbstractWWGraphQLEndpoint

All Implemented Interfaces:

IWWGraphQLEndpoint

Direct Known Subclasses:

FilePostToSpaceEndpoint, FocusPostEndpoint, MessagePostEndpoint, PhotoPostEndpoint, WWGraphQLEndpoint

public abstract class AbstractWWGraphQLEndpoint
extends Object
implements IWWGraphQLEndpoint

Since:

0.5.0 Abstract default implementation of IWWGraphQLEndpoint interface. In any overloaded object, a result needs constructing and passing into the object. The parseResultContainer() method needs to be overloaded.

Author:

Paul Withers, Christian Guedemann

Constructor Summary

Constructors

Constructor and Description
AbstractWWGraphQLEndpoint(IWWClient client)

Method Summary

Modifier and Type	Method and Description
void	executeRequest() Runs the main code to execute the GraphQL request on Watson Work Services.
Map<String,Object>	getAliasedChildren()
IWWClient	getClient()
Boolean	getProfileDump()
GraphQLRequest	getRequest()
GraphResultContainer	getResultContainer()
String	getResultContent()
Object	parseResultContainer() Parses the ResultContainer to return the relevant Java object of results.
void	setProfileDump(Boolean profileDump)
void	setRequest(GraphQLRequest request)
void	setResultContainer(GraphResultContainer resultContainer)
void	setResultContent(String resultContent)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractWWGraphQLEndpoint

public AbstractWWGraphQLEndpoint(IWWClient client)

Parameters:

client - WWClient containing authentication details and token

Since:

0.5.0

Method Detail

getClient

public IWWClient getClient()

Specified by:

getClient in interface IWWGraphQLEndpoint

Returns:

WWClient passed into constructor

getRequest

public GraphQLRequest getRequest()

Specified by:

getRequest in interface IWWGraphQLEndpoint

Returns:

GraphQLRequest, request details to be passed to the endpoint

setRequest

public void setRequest(GraphQLRequest request)

Specified by:

setRequest in interface IWWGraphQLEndpoint

Parameters:

request - GraphQLRequest, request details to be passed to the endpoint

getResultContainer

public GraphResultContainer getResultContainer()

Specified by:

getResultContainer in interface IWWGraphQLEndpoint

Returns:

GraphResultContainer generated by a successful IWWGraphQLEndpoint.executeRequest()

setResultContainer

public void setResultContainer(GraphResultContainer resultContainer)

Specified by:

setResultContainer in interface IWWGraphQLEndpoint

Parameters:

resultContainer - GraphResultContainer generated by a successful IWWGraphQLEndpoint.executeRequest(). Should not need overloading, but just in case, this method is still exposed

executeRequest

public void executeRequest()
                    throws WWException

Description copied from interface: IWWGraphQLEndpoint

Runs the main code to execute the GraphQL request on Watson Work Services. IWWGraphQLEndpoint.setRequest(GraphQLRequest) must be called before calling this method. This method should not need overloading.

Specified by:

executeRequest in interface IWWGraphQLEndpoint

Throws:

WWException - containing an error message, if the request was unsuccessful

getResultContent

public String getResultContent()

Specified by:

getResultContent in interface IWWGraphQLEndpoint

Returns:

String raw JSON results as String

setResultContent

public void setResultContent(String resultContent)

Specified by:

setResultContent in interface IWWGraphQLEndpoint

Parameters:

resultContent - String raw JSON results as string

parseResultContainer

public Object parseResultContainer()
                            throws WWException

Description copied from interface: IWWGraphQLEndpoint

Parses the ResultContainer to return the relevant Java object of results. This method should be overloaded by any implementation.

Specified by:

parseResultContainer in interface IWWGraphQLEndpoint

Returns:

Object containing the contents of the result

Throws:

WWException - containing an error message, if the request was unsuccessful

getProfileDump

public Boolean getProfileDump()

Specified by:

getProfileDump in interface IWWGraphQLEndpoint

Returns:

Boolean whether or not to dump profile data of query and response time

setProfileDump

public void setProfileDump(Boolean profileDump)

Specified by:

setProfileDump in interface IWWGraphQLEndpoint

Parameters:

profileDump - Boolean whether or not to dump profile data of query and response time

getAliasedChildren

public Map<String,Object> getAliasedChildren()
                                      throws WWException

Throws:

WWException