BaseServlet

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.yworks.yfiles.server.tiles.servlet
Class BaseServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          com.yworks.yfiles.server.tiles.servlet.BaseServlet

All Implemented Interfaces:: Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:: LayoutServlet, LoaderServlet, QueryServlet, SVGServlet, TileServlet, UndoServlet, UpdateServlet

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

This is an abstract base class for the servlets in the yFiles AJAX servlet package. It provides utilities for server side code. These are

caching graphs
handling IDs of graph elements
assigning and querying URLs and descriptions registered with graph nodes
customizing the view instances used for rendering graph tiles.

See Also:: cacheGraph(HttpSession,String,Graph2D), getId(Graph2D, Node), getNodeURL(Graph2D, Node), addViewConfigurator(Graph2D, ViewConfigurator), Serialized Form

Field Summary
`static Object`	`EDGE_DESCRIPTION_KEY` DataProvider key used for `setEdgeDescription(y.view.Graph2D, y.base.Edge, String)` and `getEdgeDescription(y.view.Graph2D, y.base.Edge)`
`static Object`	`EDGE_URL_KEY` DataProvider key used for `setEdgeURL(y.view.Graph2D, y.base.Edge, String)` and `getEdgeURL(y.view.Graph2D, y.base.Edge)`
`static Object`	`NODE_DESCRIPTION_KEY` DataProvider key used for `setNodeDescription(y.view.Graph2D, y.base.Node, String)` and `getNodeDescription(y.view.Graph2D, y.base.Node)`
`static Object`	`NODE_URL_KEY` DataProvider key used for `setNodeURL(y.view.Graph2D, y.base.Node, String)` and `getNodeURL(y.view.Graph2D, y.base.Node)`

Constructor Summary
`BaseServlet()`

Method Summary
`static void`	`addViewConfigurator(Graph2D graph, ViewConfigurator viewConfigurator)` adds the view configurator for the given graph.
`static String[]`	`cachedGraphs(javax.servlet.http.HttpSession session)` returns the names of the cached graphs for the given session.
`static void`	`cacheGraph(javax.servlet.http.HttpSession session, String graphName, Graph2D graph)` caches the given graph for the given name in the given session.
`protected void`	`doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` calls `handleGetRequest(HttpServletRequest,HttpServletResponse)`.
`protected void`	`doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` calls `handlePostRequest(HttpServletRequest,HttpServletResponse)`.
`static String`	`getEdgeDescription(Graph2D graph, Edge edge)` returns a description for a given edge.
`static URL`	`getEdgeURL(Graph2D graph, Edge edge)` returns a URL for a given edge.
`static Object`	`getForId(Graph2D graph, String id)` returns a graph element (node, edge, node label or edge label) for a given graph and an id or `null`, if not found.
`static Graph2D`	`getGraph(javax.servlet.http.HttpSession session, String graphName)` returns the graph cached for the given session and name or `null`, if not found.
`static Rectangle`	`getGraphBounds(javax.servlet.http.HttpSession session, String graphName)` returns the bounds of the cached graph for the given name and session or `null`, if not found.
`static Rectangle`	`getGraphContentBounds(javax.servlet.http.HttpSession session, String graphName)` returns the content bounds of the cached graph for the given name and session or `null`, if not found.
`static String`	`getId(Graph2D graph, Edge e)` Returns a unique ID for the given edge of the given graph.
`static String`	`getId(Graph2D graph, EdgeLabel el)` Returns a unique ID for the given edge label of the given graph.
`static String`	`getId(Graph2D graph, Node n)` Returns a unique ID for the given node of the given graph.
`static String`	`getId(Graph2D graph, NodeLabel nl)` Returns a unique ID for the given node label of the given graph.
`static String`	`getNodeDescription(Graph2D graph, Node node)` returns a description for a given node.
`static URL`	`getNodeURL(Graph2D graph, Node node)` returns a URL for a given node.
`static ReadWriteLock`	`getReadWriteLock(Graph2D graph)` Get the ReadWriteLock instance associated with the provided graph.
`static Object`	`getSessionMonitor(javax.servlet.http.HttpSession session)` Returns a monitor object attached to the provided session that can be used to synchronize on the session.
`static Set`	`getViewConfigurators(Graph2D graph)`
`static PrintWriter`	`getWriter(javax.servlet.http.HttpServletResponse response)` returns a `PrintWriter` for the given response with content type "text/json".
`protected void`	`handleGetRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` handles GET requests.
`protected void`	`handlePostRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` handles POST requests.
`static boolean`	`hasDescriptions(Graph2D graph)` returns `true`, if there is a data provider for descriptions for the given graph.
`static boolean`	`hasURLs(Graph2D graph)` returns `true`, if there is a data provider for URLs for the given graph.
`void`	`init()` calls `initialize()`.
`void`	`initialize()` Deprecated. use `init()` instead.
`static boolean`	`isUseJSONPrefixing()`
`static String`	`lookupId(Graph2D graph, Edge edge)` Returns the id that is assigned to the provided edge, or `null` if no id was assigned yet.
`static String`	`lookupId(Graph2D graph, EdgeLabel edgeLabel)` Returns the id that is assigned to the provided edge label, or `null` if no id was assigned yet.
`static String`	`lookupId(Graph2D graph, Node node)` Returns the id that is assigned to the provided node, or `null` if no id was assigned yet.
`static String`	`lookupId(Graph2D graph, NodeLabel nodeLabel)` Returns the id that is assigned to the provided label, or `null` if no id was assigned yet.
`static Graph2D`	`newGraph()` returns a new empty graph which already has a hierarchy manager.
`static void`	`readLock(Graph2D graph)` Aquire a read lock for the provided graph.
`static void`	`registerLicense(String licenseData)` Register the yFiles AJAX license data as an xml string.
`static void`	`removeViewConfigurator(Graph2D graph, ViewConfigurator viewConfigurator)` removes the view configurator for the given graph.
`static void`	`setEdgeDescription(Graph2D graph, Edge edge, String desc)` sets the description for a given edge.
`static void`	`setEdgeURL(Graph2D graph, Edge edge, String urlString)` sets the URL for a given edge.
`static void`	`setNodeDescription(Graph2D graph, Node node, String desc)` sets the description for a given node.
`static void`	`setNodeURL(Graph2D graph, Node node, String urlString)` sets the URL for a given node.
`static void`	`uncacheGraph(javax.servlet.http.HttpSession session, String graphName)` removes the graph cached for the given name from the cache for the given session.
`static void`	`unlockRead(Graph2D graph)` Release a read lock that has been aquired for the provided graph.
`static void`	`unlockWrite(Graph2D graph)` Release a write lock that has been aquired for the provided graph.
`static void`	`updateEdgePaths(Graph2D graph)` Make sure that the edge realizers are not dirty.
`static void`	`validateIds(Graph2D graph)` Make sure that a unique id is assigned to all nodes, edges, node labels and edge labels.
`static void`	`writeContentBounds(String graphName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`static void`	`writeLock(Graph2D graph)` Acquire a write lock for the provided graph.
`static void`	`writeWorldBounds(String graphName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` writes the world bounds of the graph with the given name cached for the session of the given request to the given response in JSON format.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, 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

Field Detail

NODE_URL_KEY

public static final Object NODE_URL_KEY

DataProvider key used for setNodeURL(y.view.Graph2D, y.base.Node, String) and getNodeURL(y.view.Graph2D, y.base.Node)

EDGE_URL_KEY

public static final Object EDGE_URL_KEY

DataProvider key used for setEdgeURL(y.view.Graph2D, y.base.Edge, String) and getEdgeURL(y.view.Graph2D, y.base.Edge)

NODE_DESCRIPTION_KEY

public static final Object NODE_DESCRIPTION_KEY

DataProvider key used for setNodeDescription(y.view.Graph2D, y.base.Node, String) and getNodeDescription(y.view.Graph2D, y.base.Node)

EDGE_DESCRIPTION_KEY

public static final Object EDGE_DESCRIPTION_KEY

DataProvider key used for setEdgeDescription(y.view.Graph2D, y.base.Edge, String) and getEdgeDescription(y.view.Graph2D, y.base.Edge)

Constructor Detail

BaseServlet

public BaseServlet()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

calls initialize().

Throws:: javax.servlet.ServletException

isUseJSONPrefixing

public static boolean isUseJSONPrefixing()

initialize

public void initialize()
                throws javax.servlet.ServletException

Deprecated. use init() instead.

called by init() for backwards compatibility. In previous releases, init() was final.

Throws:: javax.servlet.ServletException - if servlet related problems occur

doPost

protected final void doPost(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws javax.servlet.ServletException,
                            IOException

calls handlePostRequest(HttpServletRequest,HttpServletResponse).

Parameters:: request - the request; response - the response
Throws:: javax.servlet.ServletException; IOException

handlePostRequest

protected void handlePostRequest(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws javax.servlet.ServletException,
                                 IOException

handles POST requests. This is an empty method for BaseServlet. Subclasses should redefine this method, if necessary. Note that doPost(HttpServletRequest,HttpServletResponse) is final.

Parameters:: request - the request from a client; response - the response to be sent to the client
Throws:: IOException - if I/O problems occur; javax.servlet.ServletException - if servlet related problems occur

doGet

protected final void doGet(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws javax.servlet.ServletException,
                           IOException

calls handleGetRequest(HttpServletRequest,HttpServletResponse).

Parameters:: request - the request; response - the response
Throws:: javax.servlet.ServletException; IOException

handleGetRequest

protected void handleGetRequest(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws javax.servlet.ServletException,
                                IOException

handles GET requests. This is an empty method for BaseServlet. Subclasses should redefine this method, if necessary. Note that doGet(HttpServletRequest,HttpServletResponse) is final.

Parameters:: request - the request from a client; response - the response to be sent to the client
Throws:: IOException - if I/O problems occur; javax.servlet.ServletException - if servlet related problems occur

registerLicense

public static void registerLicense(String licenseData)

Register the yFiles AJAX license data as an xml string. This method can be used as an alternative to deployment of the license xml file to the WEB-INF directory. Note that this method has to be called before any servlet requests are handled by the BaseServlet or any derived Servlets.

Parameters:: licenseData - The license data as an xml string.

getWriter

public static PrintWriter getWriter(javax.servlet.http.HttpServletResponse response)
                             throws IOException

returns a PrintWriter for the given response with content type "text/json".

Parameters:: response - the given response
Returns:: a "text/json" writer
Throws:: IOException - if the writer cannot be obtained

writeWorldBounds

public static void writeWorldBounds(String graphName,
                                    javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                             throws IOException

writes the world bounds of the graph with the given name cached for the session of the given request to the given response in JSON format. If there are no cached bounds, default bounds (0,0,500,300) are returned.

Parameters:: graphName - the name of the graph; request - a servlet request; response - the response for the request
Throws:: IOException - for problems writing the response

writeContentBounds

public static void writeContentBounds(String graphName,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws IOException

Throws:: IOException

getForId

public static Object getForId(Graph2D graph,
                              String id)

returns a graph element (node, edge, node label or edge label) for a given graph and an id or null, if not found.

Parameters:: graph - the graph; id - the id of the graph element
Returns:: the node, edge, node label or edge label belonging to the given graph with the index equal to the given id or null

getId

public static String getId(Graph2D graph,
                           Node n)

Returns a unique ID for the given node of the given graph. If no id has been assigned to the provided item yet, a new unique id is created, assigned and returned.

Parameters:: graph - the graph; n - the node
Returns:: a unique ID
See Also:: lookupId(y.view.Graph2D, y.base.Node), validateIds(y.view.Graph2D), getId(Graph2D, NodeLabel), getId(Graph2D, Edge)

validateIds

public static void validateIds(Graph2D graph)

Make sure that a unique id is assigned to all nodes, edges, node labels and edge labels.

See Also:: getId(y.view.Graph2D, y.base.Node), getId(y.view.Graph2D, NodeLabel), getId(y.view.Graph2D, y.base.Edge), getId(y.view.Graph2D, y.view.EdgeLabel), lookupId(y.view.Graph2D, y.base.Node), lookupId(y.view.Graph2D, NodeLabel), lookupId(y.view.Graph2D, y.base.Edge)

lookupId

public static String lookupId(Graph2D graph,
                              Node node)

Returns the id that is assigned to the provided node, or null if no id was assigned yet. Use getId(y.view.Graph2D, y.base.Node) if a valid id should be created if necessary.

See Also:: getId(y.view.Graph2D, y.base.Node), validateIds(y.view.Graph2D)

lookupId

public static String lookupId(Graph2D graph,
                              Edge edge)

Returns the id that is assigned to the provided edge, or null if no id was assigned yet. Use getId(y.view.Graph2D, y.base.Edge) if a valid id should be created if necessary.

See Also:: getId(y.view.Graph2D, y.base.Edge), validateIds(y.view.Graph2D)

lookupId

public static String lookupId(Graph2D graph,
                              NodeLabel nodeLabel)

Returns the id that is assigned to the provided label, or null if no id was assigned yet. Use getId(y.view.Graph2D, y.view.NodeLabel) if a valid id should be created if necessary.

See Also:: getId(y.view.Graph2D, y.view.NodeLabel), validateIds(y.view.Graph2D)

lookupId

public static String lookupId(Graph2D graph,
                              EdgeLabel edgeLabel)

Returns the id that is assigned to the provided edge label, or null if no id was assigned yet. Use getId(y.view.Graph2D, y.view.EdgeLabel) if a valid id should be created if necessary.

See Also:: getId(y.view.Graph2D, y.view.EdgeLabel), validateIds(y.view.Graph2D)

getId

public static String getId(Graph2D graph,
                           NodeLabel nl)

Returns a unique ID for the given node label of the given graph. If no id has been assigned to the provided item yet, a new unique id is created, assigned and returned.

Parameters:: graph - the graph; nl - the node label
Returns:: a unique ID
See Also:: lookupId(y.view.Graph2D, y.view.NodeLabel), getId(Graph2D, Node), getId(Graph2D, Edge), validateIds(y.view.Graph2D)

getId

public static String getId(Graph2D graph,
                           Edge e)

Returns a unique ID for the given edge of the given graph. If no id has been assigned to the provided item yet, a new unique id is created, assigned and returned.

Parameters:: graph - the graph; e - the edge
Returns:: a unique ID
See Also:: lookupId(y.view.Graph2D, y.base.Edge), validateIds(y.view.Graph2D), getId(Graph2D, EdgeLabel), getId(Graph2D, Node)

getId

public static String getId(Graph2D graph,
                           EdgeLabel el)

Returns a unique ID for the given edge label of the given graph. If no id has been assigned to the provided item yet, a new unique id is created, assigned and returned.

Parameters:: graph - the graph; el - the edge label
Returns:: a unique ID
See Also:: lookupId(y.view.Graph2D, y.view.EdgeLabel), validateIds(y.view.Graph2D), getId(Graph2D, Edge), getId(Graph2D, Node)

hasURLs

public static boolean hasURLs(Graph2D graph)

returns true, if there is a data provider for URLs for the given graph.

Parameters:: graph - the given graph
Returns:: true, if there is a data provider for URLs
See Also:: hasDescriptions(Graph2D), getNodeURL(Graph2D, Node), getEdgeURL(Graph2D, Edge)

getNodeURL

public static URL getNodeURL(Graph2D graph,
                             Node node)

returns a URL for a given node.

Parameters:: graph - the graph, the node belongs to; node - the given node
Returns:: a URL or null
See Also:: hasURLs(Graph2D), setNodeURL(Graph2D, Node, String)

setNodeURL

public static void setNodeURL(Graph2D graph,
                              Node node,
                              String urlString)

sets the URL for a given node.

Parameters:: graph - the graph, the node belongs to; node - the given node; urlString - the URL to set
See Also:: hasURLs(Graph2D), getNodeURL(Graph2D, Node)

getEdgeURL

public static URL getEdgeURL(Graph2D graph,
                             Edge edge)

returns a URL for a given edge.

Parameters:: graph - the graph, the edge belongs to; edge - the given edge
Returns:: a URL or null
See Also:: hasURLs(Graph2D), setEdgeURL(Graph2D, Edge, String)

setEdgeURL

public static void setEdgeURL(Graph2D graph,
                              Edge edge,
                              String urlString)

sets the URL for a given edge.

Parameters:: graph - the graph, the node belongs to; edge - the given edge; urlString - the URL to set
See Also:: hasURLs(Graph2D), getEdgeURL(Graph2D, Edge)

hasDescriptions

public static boolean hasDescriptions(Graph2D graph)

returns true, if there is a data provider for descriptions for the given graph.

Parameters:: graph - the given graph
Returns:: true, if there is a data provider for descriptions
See Also:: hasURLs(Graph2D), getNodeDescription(Graph2D, Node), getEdgeDescription(Graph2D, Edge)

getNodeDescription

public static String getNodeDescription(Graph2D graph,
                                        Node node)

returns a description for a given node.

Parameters:: graph - the graph, the node belongs to; node - the given node
Returns:: a description or null
See Also:: hasDescriptions(Graph2D), setNodeDescription(Graph2D, Node, String)

setNodeDescription

public static void setNodeDescription(Graph2D graph,
                                      Node node,
                                      String desc)

sets the description for a given node.

Parameters:: graph - the graph, the node belongs to; node - the given node; desc - the description to be set
See Also:: hasDescriptions(Graph2D), getNodeDescription(Graph2D, Node)

getEdgeDescription

public static String getEdgeDescription(Graph2D graph,
                                        Edge edge)

returns a description for a given edge.

Parameters:: graph - the graph, the edge belongs to; edge - the given edge
Returns:: a description or null
See Also:: hasDescriptions(Graph2D), setEdgeDescription(Graph2D, Edge, String)

setEdgeDescription

public static void setEdgeDescription(Graph2D graph,
                                      Edge edge,
                                      String desc)

sets the description for a given edge.

Parameters:: graph - the graph, the node belongs to; edge - the given edge; desc - the description to be set
See Also:: hasDescriptions(Graph2D), getEdgeDescription(Graph2D, Edge)

cacheGraph

public static void cacheGraph(javax.servlet.http.HttpSession session,
                              String graphName,
                              Graph2D graph)

caches the given graph for the given name in the given session. In addition to the graph itself the world bounds for the graph are cached. Several graphs can be cached, if they are cached using distinct names. If a graph is cached using a name which was already used before, the former cached graph gets overwritten. If the session, the graph name or the graph is null this method does nothing.

Parameters:: session - the session for caching; graphName - the name for the graph; graph - the graph to cache
See Also:: cachedGraphs(HttpSession), uncacheGraph(HttpSession, String), getGraph(HttpSession,String), getGraphBounds(HttpSession,String)

getSessionMonitor

public static Object getSessionMonitor(javax.servlet.http.HttpSession session)

Returns a monitor object attached to the provided session that can be used to synchronize on the session. The returned object can be used as a synchronization monitor instead of the session instance itself in order to prevent deadlocks.

Returns:: An object attached to the session as an attribute using a well-known key. If no such object exists yet, it is created.

uncacheGraph

public static void uncacheGraph(javax.servlet.http.HttpSession session,
                                String graphName)

removes the graph cached for the given name from the cache for the given session. If the session or the graph name is null this method does nothing.

Parameters:: session - the session; graphName - the name of an entry to be removed from the cache
See Also:: cacheGraph(HttpSession, String, Graph2D), cachedGraphs(HttpSession)

cachedGraphs

public static String[] cachedGraphs(javax.servlet.http.HttpSession session)

returns the names of the cached graphs for the given session. For an empty session this method returns an empty array.

Parameters:: session - the session
Returns:: the names of the cached graphs
See Also:: cacheGraph(HttpSession,String,Graph2D), getGraph(HttpSession,String), getGraphBounds(HttpSession,String)

newGraph

public static Graph2D newGraph()

returns a new empty graph which already has a hierarchy manager.

Returns:: a new graph.

updateEdgePaths

public static void updateEdgePaths(Graph2D graph)

Make sure that the edge realizers are not dirty. This method can be called to ensure that subsequent paint calls will not recalculate edge paths.

See Also:: EdgeRealizer.isDirty()

getGraph

public static Graph2D getGraph(javax.servlet.http.HttpSession session,
                               String graphName)

returns the graph cached for the given session and name or null, if not found.

Parameters:: session - the session; graphName - the name of the graph
Returns:: the cached graph or null
See Also:: cacheGraph(HttpSession,String,Graph2D), getGraphBounds(HttpSession,String)

getGraphBounds

public static Rectangle getGraphBounds(javax.servlet.http.HttpSession session,
                                       String graphName)

returns the bounds of the cached graph for the given name and session or null, if not found.

Parameters:: session - the session; graphName - the name of the graph
Returns:: the bounds of the cached graph or null
See Also:: cacheGraph(HttpSession,String,Graph2D), getGraph(HttpSession,String)

getGraphContentBounds

public static Rectangle getGraphContentBounds(javax.servlet.http.HttpSession session,
                                              String graphName)

returns the content bounds of the cached graph for the given name and session or null, if not found. The content bounds take the view configurators into account.

Parameters:: session - the session; graphName - the name of the graph
Returns:: the content bounds of the cached graph or null
See Also:: cacheGraph(HttpSession,String,Graph2D), getGraph(HttpSession,String)

addViewConfigurator

public static void addViewConfigurator(Graph2D graph,
                                       ViewConfigurator viewConfigurator)

adds the view configurator for the given graph. If the graph or the configurator is null the method does nothing. If the given view configurator already belongs to the set of view configurators for this graph, it will not be added again.

Parameters:: graph - the graph; viewConfigurator - the configurator
See Also:: getViewConfigurators(Graph2D), removeViewConfigurator(Graph2D, ViewConfigurator)

removeViewConfigurator

public static void removeViewConfigurator(Graph2D graph,
                                          ViewConfigurator viewConfigurator)

removes the view configurator for the given graph. If the graph or the configurator is null the method does nothing.

Parameters:: graph - the graph; viewConfigurator - the configurator
See Also:: getViewConfigurators(Graph2D), removeViewConfigurator(Graph2D, ViewConfigurator)

getViewConfigurators

public static Set getViewConfigurators(Graph2D graph)

Parameters:: graph - a graph
Returns:: returns an unmodifiable set of the ViewConfigurators for the graph.
See Also:: addViewConfigurator(Graph2D, ViewConfigurator), removeViewConfigurator(Graph2D, ViewConfigurator)

readLock

public static void readLock(Graph2D graph)

Aquire a read lock for the provided graph. If there are currently no writers for the provided graph, the read lock is aquired immediately. Otherwise, the thread waits until the write lock is released. The read lock has to be released using unlockRead(y.view.Graph2D):

 BaseServlet.readLock(graph);
 try {
   // read graph, e.g. iterate over the graph's nodes
 } finally {
   BaseServlet.unlockRead(graph)
 }

Parameters:: graph - The graph instance that will be accessed by the read operation
See Also:: ReadWriteLock, unlockRead(y.view.Graph2D), writeLock(y.view.Graph2D), getReadWriteLock(y.view.Graph2D)

unlockRead

public static void unlockRead(Graph2D graph)

Release a read lock that has been aquired for the provided graph.

Parameters:: graph - The graph instance that was accessed by the calling thread
See Also:: ReadWriteLock, readLock(y.view.Graph2D), getReadWriteLock(y.view.Graph2D)

writeLock

public static void writeLock(Graph2D graph)

Acquire a write lock for the provided graph. If no readers or writers have currently aquired a lock for the provided graph, or if the calling thread already holds the write lock, the write lock is aquired immediately. The write lock can be acquired if:

No readers or writers have currently acquired a read or write lock
The calling thread is the only reader
The calling thread already has the write lock

If another thread currently has the read or write lock, the calling thread waits until the write lock can be acquired. The write lock has to be released using unlockWrite(y.view.Graph2D):

 BaseServlet.writeLock(graph);
 try {
   // modify the graph, e.g. add nodes or edges
 } finally {
   BaseServlet.unlockWrite(graph)
 }

Parameters:: graph - The graph instance that will be modified by the calling thread
See Also:: ReadWriteLock, unlockWrite(y.view.Graph2D), readLock(y.view.Graph2D), getReadWriteLock(y.view.Graph2D)

unlockWrite

public static void unlockWrite(Graph2D graph)

Release a write lock that has been aquired for the provided graph.

Parameters:: graph - The graph instance that was modified by the calling thread
See Also:: ReadWriteLock, readLock(y.view.Graph2D), getReadWriteLock(y.view.Graph2D)

getReadWriteLock

public static ReadWriteLock getReadWriteLock(Graph2D graph)

Get the ReadWriteLock instance associated with the provided graph. If no ReadWriteLock instance is associated with the provided graph yet, a new ReadWriteLock instance is created and attached to the graph using a constant data provider.

Parameters:: graph - A graph instance to obtain read/write locks for.
Returns:: A ReadWriteLock instance that can be used to acquire and release read and write locks for the provided graph.
See Also:: readLock(y.view.Graph2D), unlockRead(y.view.Graph2D), writeLock(y.view.Graph2D), unlockWrite(y.view.Graph2D)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.yworks.yfiles.server.tiles.servlet Class BaseServlet

NODE_URL_KEY

EDGE_URL_KEY

NODE_DESCRIPTION_KEY

EDGE_DESCRIPTION_KEY

BaseServlet

init

isUseJSONPrefixing

initialize

doPost

handlePostRequest

doGet

handleGetRequest

registerLicense

getWriter

writeWorldBounds

writeContentBounds

getForId

getId

validateIds

lookupId

lookupId

lookupId

lookupId

getId

getId

getId

hasURLs

getNodeURL

setNodeURL

getEdgeURL

setEdgeURL

hasDescriptions

getNodeDescription

setNodeDescription

getEdgeDescription

setEdgeDescription

cacheGraph

getSessionMonitor

uncacheGraph

cachedGraphs

newGraph

updateEdgePaths

getGraph

getGraphBounds

getGraphContentBounds

addViewConfigurator

removeViewConfigurator

getViewConfigurators

readLock

unlockRead

writeLock

unlockWrite

getReadWriteLock

com.yworks.yfiles.server.tiles.servlet
Class BaseServlet