com.aspc.cms.rest.impl

Class RestLocalClient

java.lang.Object

com.supertracker.Servlets.HttpClient

com.supertracker.Servlets.WebClient

com.aspc.cms.rest.impl.RestLocalClient

All Implemented Interfaces:

ServerProcess

public class RestLocalClient
extends WebClient

Since:

20 March 2015

Author:

Lei Gao

Nested Class Summary

Nested classes/interfaces inherited from class com.supertracker.Servlets.WebClient

WebClient.SCHEMA_MODE, WebClient.SCREEN_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
HttpClient	currentClient

Fields inherited from class com.supertracker.Servlets.WebClient

COOKIE_KNOWN_DEVICE, COOKIE_LOGIN_ID, COOKIE_PERSON_ID, COOKIE_REMEMBER_SESSION, CURRENT_SESSION, ENVIROMENT_AREA, ENVIROMENT_DISABLE_BLOCK_BROWSER, ENVIRONMENT_SWITCH_MODE, HEADER_CONTENT_TYPE, HEADER_REFERER, HEADER_USER_AGENT, MAGIC_NUMBER, OPENER_URL, PARAMETER_FORCE_COMPRESSION, REMEMBER_ME_MAX_AGE, SESSION_LOGIN_UID, TEMP_FILE_PREFIX, WINDOW_MODE

Fields inherited from class com.supertracker.Servlets.HttpClient

BY_PASS_CHECKS, CONTENT_ENCODING_BASE64, CONTENT_ENCODING_DEFLATE, CONTENT_ENCODING_GZIP, cookiesWritten, currentDB, currentDS, dTable, HEADER_ACCEPT_ENCODING, HEADER_CONTENT_ENCODING, HEADER_CONTENT_TRANSFER_ENCODING, request, servletPath, X_FORWARDED_PROTO

Constructor Summary

Constructors

Constructor and Description
RestLocalClient(Login login, Method method, HttpClient currentClient, Session session, java.net.URL url)

Method Summary

Modifier and Type	Method and Description
VirtualDB	getBaseDatabase() The layer for this client
java.lang.String	getHeader(java.lang.String name) Returns the request header parameter.
Login	getLogin() Get's the client's login
java.lang.String	getMethod()
java.io.BufferedReader	getReader()
java.lang.String	getRequestString()
Session	getSession() get the session
java.net.URL	getUrl()
boolean	isLoggedIn() is the client logged in ?
boolean	isRestThrottleSupported() we don't want to throttle local ReST calls
void	setHeader(java.lang.String key, java.lang.String header)
void	setIsRestThrottleSupported(boolean isRestThrottleSupported) set true to do the ReST throttling

Methods inherited from class com.supertracker.Servlets.WebClient

addCookies, addUpload, calculateSwitchMode, checkAuthorization, checkDeviceValidation, checkOTP, checkRedirect, cleanUp, doSetupDatabase, doSetupDatabase, doSimpleLogin, getAllowCORS, getBrowser, getCalculatedWindowMode, getClientIPAddress, getCurrentCMSPage, getDefaultScreenSize, getHttpSessionId, getMagicNumber, getNewPage, getNewPage, getRawParameter, getReadOnlyDataSource, getSessionAttribute, getUntrustedLoginID, getUploads, getWindowMode, handleCORS, hasLoginCookie, isCleanupFiles, isDisplayOnly, isMDI, isRememberMeInTrustedZone, isSupportedBrowser, login, logout, makeBuilder, makeForm, makePage, outstandingCookieWrite, readSessionAttribute, redirectLogin, rememberMeLogin, removeSessionAttribute, send, send, setCleanupFiles, setCurrentCMSPage, setDisplayOnly, setParameter, supportsGWT, validate, writeSessionAttribute

Methods inherited from class com.supertracker.Servlets.HttpClient

clearParameters, clickedButton, currentClient, dispose, getCallURL, getCallURL, getCookies, getCookieValue, getDatabase, getDefaultSignature, getDS, getFullRequestString, getHostname, getHttpSession, getJoinRequestCount, getLayerId, getMessageID, getParameter, getParameter, getParameterInt, getParameterLong, getParameterNames, getPathInfo, getProtocolAndHostname, getReportMaxSortRows, getRequest, getRequestText, getServletPath, getSessionAttribute, getStartAfterFullLoadTime, getStartTime, getUniqueRequestCount, hasCookie, hasParameter, isDisposed, isHTTPS, isSecure, isUseCapitalParamNames, joinCommand, logException, logTime, makeServerName, makeThreadName, paused, putCookie, removeCookie, restoreClient, resumed, sendData, setDS, setPathInfo, setServletPath, setSessionAttribute, setUseCapitalParamNames, terminated, toString, writtenCookies

Methods inherited from class java.lang.Object

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

Field Detail

currentClient

public final HttpClient currentClient

Constructor Detail

RestLocalClient

public RestLocalClient(@Nonnull
                       Login login,
                       @Nonnull
                       Method method,
                       @Nullable
                       HttpClient currentClient,
                       Session session,
                       java.net.URL url)
                throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getReader

@CheckReturnValue
 @Nonnull
public java.io.BufferedReader getReader()
                                                             throws java.io.IOException

Overrides:

getReader in class WebClient

Throws:

java.io.IOException

getMethod

@Nonnull
public java.lang.String getMethod()

Overrides:

getMethod in class WebClient

getRequestString

@CheckReturnValue
 @Nonnull
public java.lang.String getRequestString()

Overrides:

getRequestString in class HttpClient

Returns:

the value

getSession

public Session getSession()

Description copied from class: WebClient

get the session

Overrides:

getSession in class WebClient

Returns:

the session

getBaseDatabase

@Nonnull
public VirtualDB getBaseDatabase()

Description copied from class: WebClient

The layer for this client

Overrides:

getBaseDatabase in class WebClient

Returns:

The layer

getLogin

@Nonnull
public Login getLogin()

Description copied from class: WebClient

Get's the client's login

Overrides:

getLogin in class WebClient

Returns:

The login

isLoggedIn

public boolean isLoggedIn()

Description copied from class: WebClient

is the client logged in ?

Overrides:

isLoggedIn in class WebClient

Returns:

true if logged in.

setHeader

public void setHeader(@Nonnull
                      java.lang.String key,
                      @Nullable
                      java.lang.String header)

getHeader

public java.lang.String getHeader(java.lang.String name)

Description copied from class: HttpClient

Returns the request header parameter.

Overrides:

getHeader in class HttpClient

Parameters:

name - The header name.

Returns:

The value of the header.

getUrl

public java.net.URL getUrl()

setIsRestThrottleSupported

public void setIsRestThrottleSupported(boolean isRestThrottleSupported)

set true to do the ReST throttling

Parameters:

isRestThrottleSupported -

isRestThrottleSupported

public boolean isRestThrottleSupported()

we don't want to throttle local ReST calls

Overrides:

isRestThrottleSupported in class HttpClient

Returns: