URLGenerator (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.jahia.services.render.URLGenerator

```
public class URLGenerator
extends Object
```
Main URL generation class. This class is exposed to the template developers to make it easy to them to access basic URLs such as ${url.edit}, ${url.userProfile}. User: toto Date: Sep 14, 2009 Time: 11:13:37 AM

Constructor Summary

Constructors
Constructor and Description

URLGenerator(RenderContext context, Resource resource)

Constructors
Constructor and Description
`URLGenerator(RenderContext context, Resource resource)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`buildURL(JCRNodeWrapper node, String template, String templateType)`
`String`	`buildURL(JCRNodeWrapper node, String languageCode, String template, String templateType)`
`String`	`buildURL(String nodePath, String languageCode, String template, String templateType)`
`String`	`getBase()`
`String`	`getBase(String languageCode)`
`String`	`getBaseContribute()`
`String`	`getBaseEdit()`
`String`	`getBaseLive()`
`String`	`getBasePlaceholders()`
`String`	`getBasePreview()`
`Map<String,String>`	`getBases()`
`String`	`getBaseUserBoardEdit()`
`String`	`getBaseUserBoardFrameEdit()`
`String`	`getBaseUserBoardFrameLive()`
`String`	`getBaseUserBoardLive()`
`String`	`getCaptcha()`
`String`	`getContext()`
`String`	`getContribute()`
`String`	`getConvert()`
`String`	`getCurrent()`
`String`	`getCurrentModule()`
`String`	`getEdit()`
`String`	`getFiles()`
`String`	`getFilesPlaceholders()`
`String`	`getFind()`
`String`	`getFindPrincipal()`
`String`	`getFindUser()`
`String`	`getFindUsersAndGroups()`
`String`	`getFindUsersAndGroupsInAcl()`
`String`	`getInitializers()`
`String`	`getLanguage(String languageCode)`
`Map<String,String>`	`getLanguages()`
`String`	`getLive()`
`String`	`getLogin()`
`String`	`getLogout()`
`String`	`getMainResource()` Returns the URL of the main resource (normally, page), depending on the current mode.
`String`	`getMyProfile()`
`String`	`getPreview()`
`String`	`getRealResource()`
`String`	`getResourcePath()`
`String`	`getServer()` Returns the server URL, including scheme, host and port, depending on the current site.
`String`	`getStudio()` Returns the URL for the current resource in studio mode.
`String`	`getStudioVisual()` Returns the URL for the current resource in visual studio mode.
`String`	`getTemplate(String template)`
`Map<String,String>`	`getTemplates()`
`String`	`getTemplatesPath()` Returns the path to the templates folder.
`String`	`getTemplateType(String templateType)`
`Map<String,String>`	`getTemplateTypes()`
`protected void`	`initURL()` Set workspace url as attribute of the current request
`String`	`toString()`
`boolean`	`uses(Resource resource)`

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

Constructor Detail

URLGenerator

public URLGenerator(RenderContext context,
                    Resource resource)

Method Detail

uses

public boolean uses(Resource resource)

initURL
```
protected void initURL()
```
Set workspace url as attribute of the current request

getResourcePath
```
public String getResourcePath()
```

getContext
```
public String getContext()
```

getFiles
```
public String getFiles()
```

getFilesPlaceholders
```
public String getFilesPlaceholders()
```

getBase
```
public String getBase()
```

getBasePlaceholders
```
public String getBasePlaceholders()
```

getLive
```
public String getLive()
```

getEdit
```
public String getEdit()
```

getPreview
```
public String getPreview()
```

getContribute
```
public String getContribute()
```

getStudio
```
public String getStudio()
```
Returns the URL for the current resource in studio mode.

Returns:

the URL for the current resource in studio mode

getStudioVisual
```
public String getStudioVisual()
```
Returns the URL for the current resource in visual studio mode.

Returns:

the URL for the current resource in visual studio mode

getFind
```
public String getFind()
```

getFindPrincipal
```
public String getFindPrincipal()
```

getLogout
```
public String getLogout()
```

getCurrentModule
```
public String getCurrentModule()
```

getCurrent
```
public String getCurrent()
```

getLanguages

public Map<String,String> getLanguages()

getLanguage

public String getLanguage(String languageCode)

getTemplates

public Map<String,String> getTemplates()

getTemplate

public String getTemplate(String template)

getTemplateTypes

public Map<String,String> getTemplateTypes()

getTemplateType

public String getTemplateType(String templateType)

getBases
```
public Map<String,String> getBases()
```

getBase

public String getBase(String languageCode)

getTemplatesPath
```
public String getTemplatesPath()
```
Returns the path to the templates folder.

Returns:

the path to the templates folder

getMainResource
```
public String getMainResource()
```
Returns the URL of the main resource (normally, page), depending on the current mode.

Returns:

the URL of the main resource (normally, page), depending on the current mode

buildURL

public String buildURL(JCRNodeWrapper node,
                       String template,
                       String templateType)

buildURL

public String buildURL(JCRNodeWrapper node,
                       String languageCode,
                       String template,
                       String templateType)

buildURL

public String buildURL(String nodePath,
                       String languageCode,
                       String template,
                       String templateType)

getInitializers
```
public String getInitializers()
```

getCaptcha
```
public String getCaptcha()
```

getBaseContribute
```
public String getBaseContribute()
```

getBaseEdit
```
public String getBaseEdit()
```

getBaseLive
```
public String getBaseLive()
```

getBasePreview
```
public String getBasePreview()
```

getConvert
```
public String getConvert()
```

getBaseUserBoardEdit
```
public String getBaseUserBoardEdit()
```

getBaseUserBoardLive
```
public String getBaseUserBoardLive()
```

getBaseUserBoardFrameEdit

public String getBaseUserBoardFrameEdit()

getBaseUserBoardFrameLive

public String getBaseUserBoardFrameLive()

getRealResource
```
public String getRealResource()
```

getServer
```
public String getServer()
```
Returns the server URL, including scheme, host and port, depending on the current site. The URL is in the form :, e.g. http://www.jahia.org:8080. The port is omitted in case of standard HTTP (80) and HTTPS (443) ports.
If the site's server name is configured to be "localhost", then take the servername from the request.

Returns:

the server URL, including scheme, host and port, depending on the current site

getMyProfile
```
public String getMyProfile()
```

getLogin
```
public String getLogin()
```

getFindUser
```
public String getFindUser()
```

getFindUsersAndGroups
```
public String getFindUsersAndGroups()
```

getFindUsersAndGroupsInAcl

public String getFindUsersAndGroupsInAcl()

toString
```
public String toString()
```
Overrides:

toString in class Object

Class URLGenerator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

URLGenerator

Method Detail

uses

initURL

getResourcePath

getContext

getFiles

getFilesPlaceholders

getBase

getBasePlaceholders

getLive

getEdit

getPreview

getContribute

getStudio

getStudioVisual

getFind

getFindPrincipal

getLogout

getCurrentModule

getCurrent

getLanguages

getLanguage

getTemplates

getTemplate

getTemplateTypes

getTemplateType

getBases

getBase

getTemplatesPath

getMainResource

buildURL

buildURL

buildURL

getInitializers

getCaptcha

getBaseContribute

getBaseEdit

getBaseLive

getBasePreview

getConvert

getBaseUserBoardEdit

getBaseUserBoardLive

getBaseUserBoardFrameEdit

getBaseUserBoardFrameLive

getRealResource

getServer

getMyProfile

getLogin

getFindUser

getFindUsersAndGroups

getFindUsersAndGroupsInAcl

toString