org.codice.ddf.endpoints.rest.action

Class ViewMetacardActionProvider

java.lang.Object

org.codice.ddf.catalog.actions.AbstractMetacardActionProvider

org.codice.ddf.endpoints.rest.action.ViewMetacardActionProvider

All Implemented Interfaces:

ActionProvider

public class ViewMetacardActionProvider
extends AbstractMetacardActionProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION
static String	TITLE

Constructor Summary

Constructors

Constructor and Description
ViewMetacardActionProvider(String id)

Method Summary

Modifier and Type	Method and Description
protected Action	createMetacardAction(String actionProviderId, String title, String description, URL url) Factory method that creates the proper Action object from the information provided.
protected URL	getMetacardActionUrl(String metacardSource, Metacard metacard) Gets the URL that will be used when the Action is created.

Methods inherited from class org.codice.ddf.catalog.actions.AbstractMetacardActionProvider

canHandle, canHandleMetacard, getAction, getId, getMetacardAction, toString

Methods inherited from class java.lang.Object

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

Field Detail

TITLE

public static final String TITLE

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

ViewMetacardActionProvider

public ViewMetacardActionProvider(String id)

Method Detail

getMetacardActionUrl

protected URL getMetacardActionUrl(String metacardSource,
                                   Metacard metacard)
                            throws Exception

Description copied from class: AbstractMetacardActionProvider

Gets the URL that will be used when the Action is created.

Specified by:

getMetacardActionUrl in class AbstractMetacardActionProvider

Parameters:

metacardSource - source ID of the Metacard

metacard - Metacard for which a URL needs to be created

Returns:

URL that will be used to create the Action

Throws:

Exception - thrown if the URL couldn't be created

createMetacardAction

protected Action createMetacardAction(String actionProviderId,
                                      String title,
                                      String description,
                                      URL url)

Description copied from class: AbstractMetacardActionProvider

Factory method that creates the proper Action object from the information provided. Must be implemented by sub-classes.

Specified by:

createMetacardAction in class AbstractMetacardActionProvider

Parameters:

actionProviderId - Action ID

title - Action title

description - Action description

url - Action url

Returns:

new Action object. Cannot be null.