ai.api.web

Class AIServiceServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

ai.api.web.AIServiceServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public abstract class AIServiceServlet
extends javax.servlet.http.HttpServlet

Basic AI service servlet. Must be initialized with PARAM_API_AI_KEY parameter. Set your api.ai access token as a value.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_API_AI_KEY Api.ai access token parameter name

Constructor Summary

Constructors

Constructor and Description
AIServiceServlet()

Method Summary

Modifier and Type	Method and Description
void	init(javax.servlet.ServletConfig config)
protected AIResponse	request(AIRequest aiRequest, AIServiceContext serviceContext) Perform request to AI data service
protected AIResponse	request(AIRequest aiRequest, javax.servlet.http.HttpSession session) Perform request to AI data service
protected AIResponse	request(AIRequest aiRequest, String sessionId) Perform request to AI data service
protected AIResponse	request(String query, AIServiceContext serviceContext) Perform request to AI data service
protected AIResponse	request(String query, javax.servlet.http.HttpSession session) Perform request to AI data service
protected AIResponse	request(String query, String sessionId) Perform request to AI data service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_API_AI_KEY

public static final String PARAM_API_AI_KEY

Api.ai access token parameter name

See Also:

Constant Field Values

Constructor Detail

AIServiceServlet

public AIServiceServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

See Also:

GenericServlet.init(ServletConfig config)

request

protected final AIResponse request(AIRequest aiRequest,
                                   AIServiceContext serviceContext)
                            throws AIServiceException

Perform request to AI data service

Parameters:

aiRequest - Request object. Cannot be null.

serviceContext - Service context. If null then default context will be used.

Returns:

Response object

Throws:

AIServiceException - Thrown on server access error

request

protected final AIResponse request(String query,
                                   AIServiceContext serviceContext)
                            throws AIServiceException

Perform request to AI data service

Parameters:

query - Request plain text string. Cannot be null.

serviceContext - Service context. If null then default context will be used.

Returns:

Response object

Throws:

AIServiceException - Thrown on server access error

request

protected final AIResponse request(AIRequest aiRequest,
                                   javax.servlet.http.HttpSession session)
                            throws AIServiceException

Perform request to AI data service

Parameters:

aiRequest - Request object. Cannot be null.

session - Session object. If null then default context will be used.

Returns:

Response object

Throws:

AIServiceException - Thrown on server access error

request

protected final AIResponse request(String query,
                                   javax.servlet.http.HttpSession session)
                            throws AIServiceException

Perform request to AI data service

Parameters:

query - Request plain text string. Cannot be null.

session - Session object. If null then default context will be used.

Returns:

Response object

Throws:

AIServiceException - Thrown on server access error

request

protected final AIResponse request(AIRequest aiRequest,
                                   String sessionId)
                            throws AIServiceException

Perform request to AI data service

Parameters:

aiRequest - Request object. Cannot be null.

sessionId - Session string id. If null then default context will be used.

Returns:

Response object

Throws:

AIServiceException - Thrown on server access error

request

protected final AIResponse request(String query,
                                   String sessionId)
                            throws AIServiceException

Perform request to AI data service

Parameters:

query - Request plain text string. Cannot be null.

sessionId - Session string id. If null then default context will be used.

Returns:

Response object

Throws:

AIServiceException - Thrown on server access error