LinkTool (Tammi Framework API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.norther.tammi.spray.media.tool
Class LinkTool

java.lang.Object
  org.norther.tammi.core.pool.RecyclableSupport
      org.norther.tammi.core.pool.PoolableSupport
          org.norther.tammi.spray.engine.tool.GlobalTool
              org.norther.tammi.spray.engine.tool.ContextTool
                  org.norther.tammi.spray.media.tool.MediaTool
                      org.norther.tammi.spray.media.tool.LinkTool

All Implemented Interfaces:: Serializable, Cloneable, EventListener, Poolable, Recyclable, ContextBindingListener

Direct Known Subclasses:: TaskTool

public class LinkTool
extends MediaTool
extends MediaTool

A request context tool supporting creation of links to media filters.

Based on TemplateLink in the Apache Jakarta Turbine project.

Author:: Dave Bryson, Jon S. Stevens, Ilkka Priha
See Also:: Serialized Form

Constructor Summary
`LinkTool()` Constructs a new link.

Method Summary
`LinkTool`	`addPathInfo(List list)` Adds a list of name=value pairs to the path info.
`LinkTool`	`addPathInfo(String name, double value)` Adds a name=value pair to the path info.
`LinkTool`	`addPathInfo(String name, int value)` Adds a name=value pair to the path info.
`LinkTool`	`addPathInfo(String name, long value)` Adds a name=value pair to the path info.
`LinkTool`	`addPathInfo(String name, Object value)` Adds a name=value pair to the path info.
`LinkTool`	`addPathInfo(String name, String value)` Adds a name=value pair to the path info.
`LinkTool`	`addQueryString(List list)` Adds a list of name=value pairs to the query string.
`LinkTool`	`addQueryString(String name)` Adds a name to the query string.
`LinkTool`	`addQueryString(String name, double value)` Adds a name=value pair to the query string.
`LinkTool`	`addQueryString(String name, int value)` Adds a name=value pair to the query string.
`LinkTool`	`addQueryString(String name, long value)` Adds a name=value pair to the query string.
`LinkTool`	`addQueryString(String name, Object value)` Adds a name=value pair to the query string.
`LinkTool`	`addQueryString(String name, String value)` Adds a name=value pair to the query string.
`boolean`	`checkPermission()` Checks execute permission for the linked URL.
`LinkTool`	`clear()` Clears all current links.
`LinkTool`	`clearBookmark()` Clears the bookmark.
`LinkTool`	`clearPathInfo()` Clears the path info.
`LinkTool`	`clearQueryString()` Clears the query string.
`Object`	`clone()`
`void`	`dispose()` Disposes the object by setting its disposed flag.
`protected String`	`encodePathInfo()` Encodes the path info.
`protected String`	`encodeQueryString()` Encodes the query string.
`boolean`	`exists()` Checks whether the linked URL exists.
`String`	`getBookmark()` Gets the linked bookmark.
`protected Filter`	`getFilter(Class clazz)` Gets the first specific filter from the filter chain.
`protected String`	`getFilterKey(Class clazz, String cached)` Gets the key of the first specific key filter from the filter chain.
`String`	`getHost()` Gets the linked host.
`protected HostFilter`	`getHostFilter()` Gets the host filter from the filter stack.
`String`	`getLink()` Gets the linked link.
`String`	`getLinkAnchor(String link)` Gets the anchor of the specified link.
`Map`	`getLinkAnchors()` Gets a map of link anchors for the current principal.
`Map`	`getLinkAnchors(boolean all)` Gets a map of all link anchors.
`String`	`getLinkBranch()` Gets the branch key of link of the current request.
`protected String`	`getLinked(String key)` Gets the linked value.
`protected LinkFilter`	`getLinkFilter()` Gets the link filter from the filter stack.
`String`	`getLocale()` Gets the linked locale.
`String`	`getPathInfo()` Gets the last component of the path info as a string.
`String`	`getPipe()` Gets the linked pipe.
`String`	`getPipeAnchor(String pipe)` Gets the anchor of the specified pipe.
`Map`	`getPipeAnchors()` Gets a map of pipe anchors for the current principal.
`Map`	`getPipeAnchors(boolean all)` Gets a map of all pipe anchors.
`String`	`getPipeBranch()` Gets the branch key of pipe of the current request.
`protected PipeFilter`	`getPipeFilter()` Gets the pipe filter from the filter stack.
`int`	`getPort()` Gets the linked port.
`String`	`getScheme()` Gets the linked scheme.
`String`	`getScriptName()` Gets the linked script name (context path + servlet path).
`String`	`getService()` Gets the linked service.
`String`	`getServiceAnchor(String service)` Gets the anchor of the specified service.
`Map`	`getServiceAnchors()` Gets a map of service anchors for the current principal.
`Map`	`getServiceAnchors(boolean all)` Gets a map of all service anchors.
`String`	`getServiceBranch()` Gets the branch key of service of the current request.
`protected ServiceFilter`	`getServiceFilter()` Gets the service filter from the filter stack.
`String`	`getServletPath()` Gets the linked servlet path.
`String`	`getSource()` Gets the linked cached source.
`String`	`getTempSource()` Gets the linked temporary source.
`String`	`getUpload()` Gets the linked upload field.
`String`	`getURL()` Gets the URL as a string.
`boolean`	`isAbsolute()` Checks whether this link is absolute.
`protected boolean`	`isPathInfoParsed()` Checks the parse path info option.
`boolean`	`isRedirected()` Checks whether this link is a redirection.
`boolean`	`isSecure()` Checks whether this link is secure.
`protected void`	`linkModified()` A callback informing subclasses about a modified link.
`MediaTool`	`removeHost()` Removes the linked host.
`LinkTool`	`removeLink()` Removes the linked link.
`protected LinkTool`	`removeLinked(String key)` Removes the linked value.
`LinkTool`	`removePathInfo(String name)` Removes a name=value pair from the path info.
`LinkTool`	`removePipe()` Removes the linked pipe.
`LinkTool`	`removeQueryString(String name)` Removes a name=value pair from the query string.
`LinkTool`	`removeService()` Removes the linked service.
`LinkTool`	`reset()` Resets the default URL.
`MediaTool`	`resetHost()` Resets the default host.
`LinkTool`	`resetLink()` Resets the default link.
`LinkTool`	`resetPipe()` Resets the default pipe.
`LinkTool`	`resetService()` Resets the default service.
`LinkTool`	`setAbsolute(boolean flag)` Sets this link to be either absolute or relative.
`LinkTool`	`setBookmark(String bm)` Sets the linked bookmark.
`MediaTool`	`setHost(String host)` Sets the linked host.
`LinkTool`	`setLink(String link)` Sets the linked link.
`protected LinkTool`	`setLinked(String key, String value)` Sets the linked value.
`LinkTool`	`setLocale(String locale)` Sets the linked locale.
`LinkTool`	`setPathInfo(String info)` Sets the last component of the path info as a string.
`LinkTool`	`setPathInfo(String info, boolean always)` Sets the last component of the path info as a string optionally only if the path info is not parsed.
`LinkTool`	`setPipe(String pipe)` Sets the linked pipe.
`LinkTool`	`setPort(int port)` Sets the linked port.
`LinkTool`	`setRedirected(boolean flag)` Sets this link to be a redirection.
`LinkTool`	`setScheme(String scheme)` Sets the linked scheme.
`LinkTool`	`setScriptName(String name)` Sets the linked script name (context path + servlet path).
`LinkTool`	`setSecure(boolean flag)` Sets this link to be either secure or non-secure.
`LinkTool`	`setSecure(boolean flag, int port)` Sets this link to be either secure or non-secure and to use a given port.
`LinkTool`	`setService(String service)` Sets the linked service.
`LinkTool`	`setServletPath(String path)` Sets the linked servlet path.
`LinkTool`	`setSource(String source)` Sets the linked source.
`LinkTool`	`setSource(String source, boolean localized)` Sets the linked localized source.
`LinkTool`	`setTempSource(String source)` Sets the linked temporary source.
`LinkTool`	`setTempSource(String source, boolean localized)` Sets the linked localized temporary source.
`LinkTool`	`setUpload(String field)` Sets the linked upload field for file uploads.
`LinkTool`	`setURL(String url)` Sets the URL as a string.
`String`	`toString()` Returns the URL as a string and clears the link to its initial state.

Methods inherited from class org.norther.tammi.spray.media.tool.MediaTool
`clearContentKey, toURL, toURL`

Methods inherited from class org.norther.tammi.spray.engine.tool.ContextTool
`getFilterChain, getFilterKey, getPrincipal, getRequest, getResponse, isFilterChanged`

Methods inherited from class org.norther.tammi.spray.engine.tool.GlobalTool
`getContext, getContextToolFilter, getMBeanServer, getName, isBound, nop, valueBound, valueUnbound`

Methods inherited from class org.norther.tammi.core.pool.PoolableSupport
`disposed, recycled`

Methods inherited from class org.norther.tammi.core.pool.RecyclableSupport
`isDisposed, recycle`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.norther.tammi.core.pool.Recyclable
`isDisposed, recycle`

Constructor Detail

LinkTool

public LinkTool()

Constructs a new link.

Method Detail

clone

public Object clone()

Overrides:: clone in class MediaTool

dispose

public void dispose()

Description copied from class: RecyclableSupport

Disposes the object by setting its disposed flag.

Specified by:: dispose in interface Recyclable
Overrides:: dispose in class MediaTool

getScheme

public String getScheme()

Gets the linked scheme.

Returns:: the scheme or null.

setScheme

public LinkTool setScheme(String scheme)

Sets the linked scheme.

Parameters:: scheme - the scheme.
Returns:: the updated tool.

getPort

public int getPort()

Gets the linked port.

Returns:: the port or 0.

setPort

public LinkTool setPort(int port)

Sets the linked port.

Parameters:: port - the port.
Returns:: the updated tool.

getScriptName

public String getScriptName()

Gets the linked script name (context path + servlet path).

Note that the context path of the link URL can't be get or set alone but only as part of the script name.

Returns:: the script name or null.

setScriptName

public LinkTool setScriptName(String name)

Sets the linked script name (context path + servlet path).

Note that setting the servlet path has no effect after the script name has been set.

Parameters:: name - the script name.
Returns:: the updated tool.

getServletPath

public String getServletPath()

Gets the linked servlet path.

Returns:: the servlet path or null.

setServletPath

public LinkTool setServletPath(String path)

Sets the linked servlet path.

Note that setting the servlet path has no effect if the script name has already been set.

Parameters:: path - the servlet path.
Returns:: the updated tool.

isSecure

public boolean isSecure()

Checks whether this link is secure.

Returns:: true for a secure link, false otherwise.

setSecure

public LinkTool setSecure(boolean flag)

Sets this link to be either secure or non-secure. The scheme and server port are updated accordingly.

Parameters:: flag - true for a secure link, false otherwise.
Returns:: the updated tool.

setSecure

public LinkTool setSecure(boolean flag,
                          int port)

Sets this link to be either secure or non-secure and to use a given port. The scheme and server port are updated accordingly.

Parameters:: flag - true for a secure link, false otherwise.; port - the server port.
Returns:: the updated tool.

isAbsolute

public boolean isAbsolute()

Checks whether this link is absolute.

Returns:: true for an absolute link, false otherwise.

setAbsolute

public LinkTool setAbsolute(boolean flag)

Sets this link to be either absolute or relative. An absolute link contains the server name and port number.

Note that setting the flag to false does not supersede the AbsoluteURLLinks configuration option.

Parameters:: flag - the absolute flag.
Returns:: the updated tool.

isRedirected

public boolean isRedirected()

Checks whether this link is a redirection.

Returns:: true for a redirection link, false otherwise.

setRedirected

public LinkTool setRedirected(boolean flag)

Sets this link to be a redirection. A redirected link is always absolute and encoded with the HttpServletRequest.encodeRedirectURL method.

Parameters:: flag - the redirected flag.
Returns:: the updated tool.

getBookmark

public String getBookmark()

Gets the linked bookmark.

Returns:: the bookmark or null.

setBookmark

public LinkTool setBookmark(String bm)

Sets the linked bookmark.

Parameters:: bm - the bookmark.
Returns:: the updated tool.

clearBookmark

public LinkTool clearBookmark()

Clears the bookmark.

Returns:: the updated tool.

getPathInfo

public String getPathInfo()

Gets the last component of the path info as a string.

Returns:: info the absolute path info or null.

setPathInfo

public LinkTool setPathInfo(String info)

Sets the last component of the path info as a string.

Parameters:: info - the path info.
Returns:: the updated tool.

setPathInfo

public LinkTool setPathInfo(String info,
                            boolean always)

Sets the last component of the path info as a string optionally only if the path info is not parsed.

Parameters:: info - the path info.; always - the always option.
Returns:: the updated tool.

addPathInfo

public LinkTool addPathInfo(List list)

Adds a list of name=value pairs to the path info. The name and the corresponding value must be subsequent items in the list.

Parameters:: list - the list.
Returns:: the updated tool.