org.gecko.util.uriprovider

Interface LocationUriConfigurer

All Known Implementing Classes:

DefaultLocationUriConfigurer

public interface LocationUriConfigurer

Configuration service for the creation, update and delete of the LocationUriProvider using configuration admin

Since:

10.11.2016

Method Summary

Modifier and Type	Method and Description
void	createLocationUri(java.lang.String id, java.lang.String schema, java.lang.String base, java.lang.String path, java.lang.String context) Creates a new configuration for a provider for the given parameters
void	deleteLocationUri(java.lang.String id) Removes a configuration with the given id
void	updateLocationUri(java.lang.String id, java.lang.String schema, java.lang.String base, java.lang.String path, java.lang.String context) Updates a new configuration for a provider for the given parameters.
void	updateLocationUri(java.lang.String id, java.lang.String schema, java.lang.String base, java.lang.String path, java.lang.String context, boolean create) Updates a new configuration for a provider for the given parameters.

Method Detail

createLocationUri

void createLocationUri(java.lang.String id,
                       java.lang.String schema,
                       java.lang.String base,
                       java.lang.String path,
                       java.lang.String context)

Creates a new configuration for a provider for the given parameters

Parameters:

id - the provider id/configuration id

schema - the uri schema

base - a base uri

path - a path under the base uri

context - a special context identifier, which is a last segment in the uri path

updateLocationUri

void updateLocationUri(java.lang.String id,
                       java.lang.String schema,
                       java.lang.String base,
                       java.lang.String path,
                       java.lang.String context)

Updates a new configuration for a provider for the given parameters. If no configuration exists this method does nothing. It is the same like calling the second method with parameter 'create=false'

Parameters:

id - the provider id/configuration id

schema - the uri schema

base - a base uri

path - a path under the base uri

context - a special context identifier, which is a last segment in the uri path

updateLocationUri

void updateLocationUri(java.lang.String id,
                       java.lang.String schema,
                       java.lang.String base,
                       java.lang.String path,
                       java.lang.String context,
                       boolean create)

Updates a new configuration for a provider for the given parameters.

Parameters:

id - the provider id/configuration id

schema - the uri schema, can be null

base - a base uri, can be null

path - a path under the base uri, can be null

context - a special context identifier, which is a last segment in the uri path, can be null

create - set to true, to create a new configuration, if none already exists

deleteLocationUri

void deleteLocationUri(java.lang.String id)

Removes a configuration with the given id

Parameters:

id - the configuration id