org.exoplatform.services.portletcontainer.plugins.pc.portletAPIImp
Class BaseURLImp

java.lang.Object
  org.exoplatform.services.portletcontainer.plugins.pc.portletAPIImp.BaseURLImp

All Implemented Interfaces:

javax.portlet.BaseURL

Direct Known Subclasses:

PortletURLImp, ResourceURLImp

public abstract class BaseURLImp
extends java.lang.Object
implements javax.portlet.BaseURL

Author:

Mestrallet Benjamin benjmestrallet@users.sourceforge.net

Field Summary

protected java.lang.String	baseURL Base url string.
protected java.util.Map<java.lang.String,java.lang.String[]>	parameters Parameters.

Constructor Summary

BaseURLImp(java.lang.String type, java.lang.String baseURL, boolean isCurrentlySecured, boolean defaultEscapeXml, Portlet portletDatas)

Method Summary

void	addProperty(java.lang.String key, java.lang.String value) Overridden method.
protected java.lang.String	encode(java.lang.String s)
protected java.lang.String	encode(java.lang.String s, boolean escapeXML)
protected java.lang.String	encodeChars(java.lang.String s)
java.util.Map<java.lang.String,java.lang.String[]>	getParameterMap() Overridden method.
protected Portlet	getPortletDatas()
java.lang.String	getPropertyString()
java.lang.String	getPropertyString(boolean escapeXML)
protected java.lang.String	getType()
protected boolean	isCurrentlySecured()
protected boolean	isSecure()
protected boolean	isSetSecureCalled()
protected void	setCurrentlySecured(boolean isCurrentlySecured)
void	setParameter(java.lang.String name, java.lang.String value) Overridden method.
void	setParameter(java.lang.String name, java.lang.String[] values) Overridden method.
void	setParameters(java.util.Map<java.lang.String,java.lang.String[]> map) Overridden method.
void	setProperty(java.lang.String key, java.lang.String value) Overridden method.
void	setSecure(boolean isSecure) Overridden method.
protected void	setSetSecureCalled(boolean setSecureCalled)
protected void	setType(java.lang.String type)
java.lang.String	toString() Overridden method.
abstract java.lang.String	toString(boolean escapeXML)
void	write(java.io.Writer out) Overridden method.
void	write(java.io.Writer out, boolean escapeXML) Overridden method.

Methods inherited from class java.lang.Object

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

Field Detail

baseURL

protected java.lang.String baseURL

Base url string.

parameters

protected java.util.Map<java.lang.String,java.lang.String[]> parameters

Parameters.

Constructor Detail

BaseURLImp

public BaseURLImp(java.lang.String type,
                  java.lang.String baseURL,
                  boolean isCurrentlySecured,
                  boolean defaultEscapeXml,
                  Portlet portletDatas)

Parameters:

type - type (render, action ...)

baseURL - base url string

isCurrentlySecured - is secured

defaultEscapeXml - either to escape xml chars (default value)

portletDatas - portlet datas

Method Detail

setParameter

public final void setParameter(java.lang.String name,
                               java.lang.String value)

Overridden method.

Specified by:

setParameter in interface javax.portlet.BaseURL

Parameters:

name - name

value - value

See Also:

BaseURL.setParameter(java.lang.String, java.lang.String)

setParameter

public final void setParameter(java.lang.String name,
                               java.lang.String[] values)

Overridden method.

Specified by:

setParameter in interface javax.portlet.BaseURL

Parameters:

name - name

values - values

See Also:

BaseURL.setParameter(java.lang.String, java.lang.String[])

setParameters

public final void setParameters(java.util.Map<java.lang.String,java.lang.String[]> map)

Overridden method.

Specified by:

setParameters in interface javax.portlet.BaseURL

Parameters:

map - parameter map

See Also:

BaseURL.setParameters(java.util.Map)

getParameterMap

public final java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()

Overridden method.

Specified by:

getParameterMap in interface javax.portlet.BaseURL

Returns:

parameter map

See Also:

BaseURL.getParameterMap()

addProperty

public final void addProperty(java.lang.String key,
                              java.lang.String value)

Overridden method.

Specified by:

addProperty in interface javax.portlet.BaseURL

Parameters:

key - key

value - value

See Also:

BaseURL.addProperty(java.lang.String, java.lang.String)

setProperty

public final void setProperty(java.lang.String key,
                              java.lang.String value)

Overridden method.

Specified by:

setProperty in interface javax.portlet.BaseURL

Parameters:

key - key

value - value

See Also:

BaseURL.setProperty(java.lang.String, java.lang.String)

getPropertyString

public final java.lang.String getPropertyString()

Returns:

property string

getPropertyString

public final java.lang.String getPropertyString(boolean escapeXML)

Parameters:

escapeXML - either to escape xml chars

Returns:

property string

setSecure

public final void setSecure(boolean isSecure)

Overridden method.

Specified by:

setSecure in interface javax.portlet.BaseURL

Parameters:

isSecure - is secure

See Also:

BaseURL.setSecure(boolean)

toString

public abstract java.lang.String toString(boolean escapeXML)

Parameters:

escapeXML - either to escape xml chars

Returns:

string representation of utl

toString

public java.lang.String toString()

Overridden method. The returned URL is not XML escaped.

Specified by:

toString in interface javax.portlet.BaseURL

Overrides:

toString in class java.lang.Object

Returns:

string representation of url

See Also:

Object.toString()

encode

protected java.lang.String encode(java.lang.String s,
                                  boolean escapeXML)

Parameters:

s - string to encode

escapeXML - either to escape xml chars

Returns:

encoded string

encode

protected final java.lang.String encode(java.lang.String s)

Parameters:

s - string to encode

Returns:

encoded string

encodeChars

protected final java.lang.String encodeChars(java.lang.String s)

Parameters:

s - string to encode

Returns:

encoded string

write

public final void write(java.io.Writer out)
                 throws java.io.IOException

Overridden method. The URL written to the output stream is always XML escaped.

Specified by:

write in interface javax.portlet.BaseURL

Parameters:

out - writer

Throws:

java.io.IOException - exception

See Also:

BaseURL.write(java.io.Writer)

write

public final void write(java.io.Writer out,
                        boolean escapeXML)
                 throws java.io.IOException

Overridden method.

Specified by:

write in interface javax.portlet.BaseURL

Parameters:

out - writer

escapeXML - either to escape xml chars

Throws:

java.io.IOException - exception

See Also:

BaseURL.write(java.io.Writer, boolean)

getPortletDatas

protected Portlet getPortletDatas()

Returns:

the portletDatas

setType

protected void setType(java.lang.String type)

Parameters:

type - the type to set

getType

protected java.lang.String getType()

Returns:

the type

setCurrentlySecured

protected void setCurrentlySecured(boolean isCurrentlySecured)

Parameters:

isCurrentlySecured - the isCurrentlySecured to set

isCurrentlySecured

protected boolean isCurrentlySecured()

Returns:

the isCurrentlySecured

setSetSecureCalled

protected void setSetSecureCalled(boolean setSecureCalled)

Parameters:

setSecureCalled - the setSecureCalled to set

isSetSecureCalled

protected boolean isSetSecureCalled()

Returns:

the setSecureCalled

isSecure

protected boolean isSecure()

Returns:

the isSecure