de.smartics.properties.admin.resources.representation.share
Class BreadcrumbHelper

java.lang.Object
  de.smartics.properties.admin.resources.representation.share.BreadcrumbHelper

public final class BreadcrumbHelper
     
     

      
      extends 
      
      Object
     
     

A simple helper to create breadcrumbs.

Constructor Summary

BreadcrumbHelper(LinkDescriptorFactory linkDescriptorFactory, String method)
Default constructor.

Method Summary

static List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	adjustSelf(List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> links) Adds the self relation to the last element in the list of links.
List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	api() Returns the breadcrumbs for the view that shows the list of services provided by the API.
List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	configuration(String configurationKey) Returns the breadcrumbs for the view that shows the list of properties by their keys.
List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	configurations() Returns the breadcrumbs for the view that shows the list of configurations by their keys.
List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	descriptor(String propertyKey) Returns the breadcrumbs for the view that shows a selected property descriptor.
List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	descriptors() Returns the breadcrumbs for the view that shows the list of property descriptors.
List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	home() Returns the breadcrumbs for the view that shows the home page.
List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	jndi() Returns the breadcrumbs for the view that allows to configure JNDI properties.
List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	property(String configurationKey, String propertyKey) Returns the breadcrumbs for the view that shows a single property.
List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	security() Returns the breadcrumbs for the view that allows to en- and decrypt property values.
de.smartics.resteasy.hypermedia.renderer.LinkDescriptor	service(ApiServices.ServiceDescriptor descriptor) Creates the link descriptor to the configurations services that is part of the API.

Methods inherited from class java.lang.Object

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

Constructor Detail

BreadcrumbHelper

public BreadcrumbHelper(LinkDescriptorFactory linkDescriptorFactory,
                        String method)

Default constructor.

Parameters:

linkDescriptorFactory - the value for linkDescriptorFactory.

method - the method to select the service method of the resource.

Method Detail

service

public de.smartics.resteasy.hypermedia.renderer.LinkDescriptor service(ApiServices.ServiceDescriptor descriptor)

Creates the link descriptor to the configurations services that is part of the API.

Parameters:

descriptor - the descriptor of the service.

Returns:

the link descriptor to the configurations services.

home

public List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> home()

Returns the breadcrumbs for the view that shows the home page.

Returns:

the link of breadcrumb elements.

api

public List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> api()

Returns the breadcrumbs for the view that shows the list of services provided by the API.

Returns:

the link of breadcrumb elements.

descriptors

public List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> descriptors()

Returns the breadcrumbs for the view that shows the list of property descriptors.

Returns:

the link of breadcrumb elements.

descriptor

public List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> descriptor(String propertyKey)

Returns the breadcrumbs for the view that shows a selected property descriptor.

Parameters:

propertyKey - the selected property key.

Returns:

the link of breadcrumb elements.

adjustSelf

public static List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> adjustSelf(List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> links)

Adds the self relation to the last element in the list of links.

Parameters:

links - the links to adjust.

Returns:

the adjusted links.

configurations

public List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> configurations()

Returns the breadcrumbs for the view that shows the list of configurations by their keys.

Returns:

the link of breadcrumb elements.

configuration

public List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> configuration(String configurationKey)

Returns the breadcrumbs for the view that shows the list of properties by their keys.

Parameters:

configurationKey - the key of the currently selected configuration.

Returns:

the link of breadcrumb elements.

property

public List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> property(String configurationKey,
                                                                              String propertyKey)

Returns the breadcrumbs for the view that shows a single property.

Parameters:

configurationKey - the key of the currently selected configuration.

propertyKey - the key of the currently selected property.

Returns:

the link of breadcrumb elements.

security

public List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> security()

Returns the breadcrumbs for the view that allows to en- and decrypt property values.

Returns:

the link of breadcrumb elements.

jndi

public List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> jndi()

Returns the breadcrumbs for the view that allows to configure JNDI properties.

Returns:

the link of breadcrumb elements.