org.jboss.dna.maven
Class MavenUrl

java.lang.Object
  org.jboss.dna.maven.MavenUrl

public class MavenUrl
extends java.lang.Object

Wrapper for a URL that uses a format for referencing JCR nodes and content.

Author:

Randall Hauch

Field Summary

static java.lang.String	JCR_PROTOCOL
static int	NO_PORT

Constructor Summary

MavenUrl()

Method Summary

java.lang.String	getHostname() Get the host name
java.lang.String	getHostnameAndPort()
java.lang.String	getPath()
int	getPort() Get the port.
java.net.URL	getUrl(java.net.URLStreamHandler handler, TextEncoder encoder) Get a URL that corresponds to the information in this object.
java.lang.String	getWorkspaceName()
static MavenUrl	parse(java.lang.String url, TextEncoder decoder) Parse the supplied URL and determine if the URL fits the JCR URL format.
static MavenUrl	parse(java.net.URL url, TextEncoder decoder) Parse the supplied URL and determine if the URL fits the JCR URL format.
void	setHostname(java.lang.String hostname)
void	setPath(java.lang.String path)
void	setPort(int port)
void	setWorkspaceName(java.lang.String workspaceName) Set the name of the workspace.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO_PORT

public static final int NO_PORT

See Also:

Constant Field Values

JCR_PROTOCOL

public static final java.lang.String JCR_PROTOCOL

See Also:

Constant Field Values

Constructor Detail

MavenUrl

public MavenUrl()

Method Detail

getHostname

public java.lang.String getHostname()

Get the host name

Returns:

the host name

setHostname

public void setHostname(java.lang.String hostname)

Parameters:

hostname - the new host name

getPort

public int getPort()

Get the port. This method returns NO_PORT if the port has not been specified.

Returns:

the port

setPort

public void setPort(int port)

Parameters:

port - the new port, or NO_PORT if there is no port

getHostnameAndPort

public java.lang.String getHostnameAndPort()

getWorkspaceName

public java.lang.String getWorkspaceName()

Returns:

workspaceName

setWorkspaceName

public void setWorkspaceName(java.lang.String workspaceName)

Set the name of the workspace.

Parameters:

workspaceName - the name of the workspace

getPath

public java.lang.String getPath()

Returns:

path

setPath

public void setPath(java.lang.String path)

Parameters:

path - Sets path to the specified value.

getUrl

public java.net.URL getUrl(java.net.URLStreamHandler handler,
                           TextEncoder encoder)
                    throws java.net.MalformedURLException

Get a URL that corresponds to the information in this object.

Parameters:

handler - the URL stream handler that will be used to handle obtaining an input stream or an output stream on the resulting URL

encoder - an encoder that will be used to escape any characters that are not allowed in URLs; UrlEncoder will be used if no encoder is specified

Returns:

the URL

Throws:

java.net.MalformedURLException - if the resulting URL would be malformed

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parse

public static MavenUrl parse(java.lang.String url,
                             TextEncoder decoder)

Parse the supplied URL and determine if the URL fits the JCR URL format. If it does, return a MavenUrl instance; otherwise return null. If the URL is malformed or otherwise invalid, this method also returns null.

The URL format is expected to fit the following pattern:

    jcr://hostname:port/workspaceName/path/to/node
 

where

• hostname is the name of the repository's host; typically, this is unspecified to refer to a repository in the same VM
• port is the port on the host. If the hostname is unspecified, the port should be excluded.
• workspaceName is the name of the workspace in the repository
• path/to/node is the path of the node or property that is to be referenced

Parameters:

url - the URL to be parsed

decoder - the text encoder that should be used to decode the URL; may be null if no decoding should be done

Returns:

the object representing the JCR information contained in the URL

parse

public static MavenUrl parse(java.net.URL url,
                             TextEncoder decoder)

Parse the supplied URL and determine if the URL fits the JCR URL format. If it does, return a MavenUrl instance; otherwise return null. If the URL is malformed or otherwise invalid, this method also returns null.

Parameters:

url - the URL to be parsed

decoder - the text encoder that should be used to decode the URL; may be null if no decoding should be done

Returns:

the object representing the JCR information contained in the URL

See Also:

parse(String,TextEncoder)