|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.GenericServlet
javax.servlet.http.HttpServlet
com.google.gwt.user.server.rpc.RemoteServiceServlet
com.tensegrity.palowebviewer.modules.engine.server.BasePaloService
com.tensegrity.palowebviewer.modules.engine.server.EngineService
public class EngineService
Nested Class Summary | |
---|---|
protected static class |
EngineService.AuthInfo
|
Field Summary |
---|
Fields inherited from class com.tensegrity.palowebviewer.modules.engine.server.BasePaloService |
---|
logic |
Constructor Summary | |
---|---|
EngineService()
|
Method Summary | |
---|---|
java.lang.Boolean |
authenticate(java.lang.String login,
java.lang.String password,
boolean remember)
This method authenticates the user. |
boolean |
checkExistance(XPath path)
This methods checks existance of objects, specified via path. |
boolean |
checkExistance(XPath contextPath,
java.lang.String elementName)
More specified version of IEngineService.checkExistance(XPath) : it checks existance by name in some context. |
void |
forceReload()
forces reload of all connection pools, e.g. |
protected EngineService.AuthInfo |
getAuthInfoFromCookies()
|
IClientProperties |
getClientProperties()
Retuns client properties from server. |
XElement[] |
getParentsOf(XPath contextPath,
java.lang.String elementName)
This method returns parents elements in element hierarchy for particular element. |
java.lang.Boolean |
isAuthenticated()
Checks if user is already authenticated. |
XObject |
loadChild(XPath path,
java.lang.String childId,
int type)
This methods loads single child specified by path to parend, id and type |
XObject |
loadChildByName(XPath path,
java.lang.String name,
int type)
|
XObject[] |
loadChildren(XPath path,
int type)
This method loads all children (XObjects) of type of object specified by path. |
XDefaultView |
loadDefaultView(XPath path)
This method constructs "default view", i.e. |
XFolder |
loadFavoriteViews()
Loads favorite views from server. |
void |
logoff()
Log off from the server. |
XResult[] |
query(XQueryPath[] queries)
This method returns data for cube, specified by query. |
java.lang.String |
saveView(XViewPath viewPath)
This method updates view if the one already exists and adds view otherwise. |
protected java.lang.Boolean |
tryCookiesAuthentication()
|
void |
updateData(XPath cube,
IXPoint point,
IResultElement value)
This method sets value of some cell of cube pointed by point |
Methods inherited from class com.tensegrity.palowebviewer.modules.engine.server.BasePaloService |
---|
getContext, init, setContext |
Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet |
---|
doGetSerializationPolicy, doPost, doUnexpectedFailure, getSerializationPolicy, getThreadLocalRequest, getThreadLocalResponse, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, shouldCompressResponse |
Methods inherited from class javax.servlet.http.HttpServlet |
---|
doDelete, doGet, doHead, doOptions, 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 |
Constructor Detail |
---|
public EngineService()
Method Detail |
---|
public java.lang.Boolean isAuthenticated()
IEngineService
If authentication succeed cookies max age setted up to 1 month.
isAuthenticated
in interface IEngineService
public java.lang.Boolean authenticate(java.lang.String login, java.lang.String password, boolean remember) throws InternalErrorException
IEngineService
authenticate
in interface IEngineService
login
- - user login. Can't be null.password
- - user password. Can't be null.remember
- - remember user and password hash in cookies.
InternalErrorException
public void logoff()
IEngineService
#authenticate()
will return TRUE.
logoff
in interface IEngineService
public XResult[] query(XQueryPath[] queries) throws InvalidObjectPathException
IEngineService
Assumption: all paths points to one server. Otherwise behavior is unpredicted (runtime exception will be thrown).
query
in interface IEngineService
queries
- - array of requests XQueryPath
. It can't be null.
InvalidObjectPathException
- is thrown if one of paths doesn't points to cube or is invalid.public void updateData(XPath cube, IXPoint point, IResultElement value) throws InvalidObjectPathException
IEngineService
updateData
in interface IEngineService
cube
- points to target cubepoint
- contains coordinates of point. @{link IXPoint}value
- of the point.
InvalidObjectPathException
- if cubePath is not valid path.public java.lang.String saveView(XViewPath viewPath) throws InvalidObjectPathException
IEngineService
saveView
in interface IEngineService
viewPath
- defines the view. @{link XViewPath}.
InvalidObjectPathException
- one of paths in viewPath is invalid.public void forceReload()
IEngineService
forceReload
in interface IEngineService
protected java.lang.Boolean tryCookiesAuthentication()
protected EngineService.AuthInfo getAuthInfoFromCookies()
public IClientProperties getClientProperties()
IEngineService
getClientProperties
in interface IEngineService
public XObject[] loadChildren(XPath path, int type) throws InvalidObjectPathException
IEngineService
loadChildren
in interface IEngineService
path
- for object. Can't be null.type
- specifies chilren type. IXConsts
. If object has only one chilren type, type param have to be ingnored.
InvalidObjectPathException
- will be thrown if path is wrong
if type is wrong program behavior is unpredicted (e.g. runtime exception will be thrown)public XElement[] getParentsOf(XPath contextPath, java.lang.String elementName) throws InvalidObjectPathException
IEngineService
getParentsOf
in interface IEngineService
contextPath
- defines context of element hierarcy. Can point only to dimension or subset. Can't be null.elementName
- element name. Can't be null.
InvalidObjectPathException
- if
1. contextPath is invalid;
2. contextPath doesn't point to dimension or subset.
3. element with elementName can't be found.public XDefaultView loadDefaultView(XPath path) throws InvalidObjectPathException
IEngineService
loadDefaultView
in interface IEngineService
path
- points to cube. Can't be null.
InvalidObjectPathException
- if path it invalid or it doen't point to cube.public boolean checkExistance(XPath contextPath, java.lang.String elementName) throws InvalidObjectPathException
IEngineService
IEngineService.checkExistance(XPath)
: it checks existance by name in some context.
checkExistance
in interface IEngineService
contextPath
- context path (currently: dimension/subset)elementName
- element name
InvalidObjectPathException
- if contextPath is invalid or not points to dimension/subsetpublic boolean checkExistance(XPath path)
IEngineService
checkExistance
in interface IEngineService
path
- for object. Can't be null.
public XFolder loadFavoriteViews()
IEngineService
loadFavoriteViews
in interface IEngineService
public XObject loadChild(XPath path, java.lang.String childId, int type) throws InvalidObjectPathException
IEngineService
loadChild
in interface IEngineService
path
- poinst to parent object.childId
- child identificatortype
- child type.
InvalidObjectPathException
- if path is invalid.public XObject loadChildByName(XPath path, java.lang.String name, int type) throws InvalidObjectPathException
loadChildByName
in interface IEngineService
InvalidObjectPathException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |