URIPrefixHandler (Ametys 4.5.x - API)

java.lang.Object
- org.ametys.cms.URIPrefixHandler

All Implemented Interfaces:

Component, Contextualizable
```
public class URIPrefixHandler
extends Object
implements Contextualizable, Component
```
Component providing base paths for computing URIs.

Field Summary

Fields
Modifier and Type Field Description

static String ROLE
Avalon role

Constructor Summary

Constructors
Constructor Description

URIPrefixHandler()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`computeUriPrefix(boolean absolute, boolean internal)`	Computes an URI prefix.
`void`	`contextualize(Context context)`
`String`	`getAbsoluteUriPrefix()`	Get the absolutized version of the context path. Use it to create an absolute link beginning with the application root, for instance when sending a mail linking to the application.
`String`	`getUriPrefix()`	Get the application root.

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

- Field Detail
  - ROLE
```
public static final String ROLE
```
    Avalon role
- Constructor Detail
  - URIPrefixHandler
```
public URIPrefixHandler()
```
- Method Detail
  - contextualize
```
public void contextualize(Context context)
                   throws ContextException
```
    Specified by:
    
    contextualize in interface Contextualizable
    
    Throws:
    
    ContextException
  - computeUriPrefix
```
public String computeUriPrefix(boolean absolute,
                               boolean internal)
```
    Computes an URI prefix. Uses by various URIResolver.
    
    Parameters:
    
    absolute - if the resulting prefix should be absolute.
    
    internal - if the resulting prefix should be internal.
    
    Returns:
    
    the computes prefix.
  - getUriPrefix
```
public String getUriPrefix()
```
    Get the application root. Can be empty if the application resides in the root context.
    Use it to create a link beginning with the application root.
    
    Returns:
    
    The application root uri.
  - getAbsoluteUriPrefix
```
public String getAbsoluteUriPrefix()
```
    Get the absolutized version of the context path.
    Use it to create an absolute link beginning with the application root, for instance when sending a mail linking to the application.
    
    Returns:
    
    The absolute context path.