org.sourceid.saml20.adapter.gui
Class ActionDescriptor

java.lang.Object
  extended by org.sourceid.saml20.adapter.gui.ActionDescriptor
All Implemented Interfaces:
java.io.Serializable

public class ActionDescriptor
extends java.lang.Object
implements java.io.Serializable

An ActionDescriptor can be used to invoke arbitrary actions on an adapter via the GUI.

Author:
Brian Campbell
See Also:
AdapterConfigurationGuiDescriptor.addAction(ActionDescriptor), Serialized Form

Nested Class Summary
static interface ActionDescriptor.Action
          The action to perform.
 
Constructor Summary
ActionDescriptor(java.lang.String name, java.lang.String description, ActionDescriptor.Action action)
           
ActionDescriptor(java.lang.String name, java.lang.String description, java.lang.String contentType, java.lang.String filename, ActionDescriptor.Action action)
           
 
Method Summary
 ActionDescriptor.Action getAction()
           
 java.lang.String getDescription()
           
 java.lang.String getDownloadContentType()
           
 java.lang.String getDownloadFilename()
           
 java.lang.String getName()
           
 boolean isDownload()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ActionDescriptor

public ActionDescriptor(java.lang.String name,
                        java.lang.String description,
                        ActionDescriptor.Action action)
Parameters:
name - the name of the action
description - a description of the action
action - an implementation of the Action interface that will be invoked when the user selects this action in the GUI.

ActionDescriptor

public ActionDescriptor(java.lang.String name,
                        java.lang.String description,
                        java.lang.String contentType,
                        java.lang.String filename,
                        ActionDescriptor.Action action)
Parameters:
name - the name of the action
description - a description of the action
contentType - the content-type that should be used when downloading the result of the action
filename - the default filename that should be used when downloading the result of the action
action - an implementation of the Action interface that will be invoked
Method Detail

getName

public java.lang.String getName()
Returns:
the name of this action.

getDescription

public java.lang.String getDescription()
Returns:
the description of this action.

getAction

public ActionDescriptor.Action getAction()
Returns:
the action implementation.

isDownload

public boolean isDownload()
Returns:
a boolean indicating if the action result should be downloaded instead of displayed

getDownloadContentType

public java.lang.String getDownloadContentType()
Returns:
content type string of action result

getDownloadFilename

public java.lang.String getDownloadFilename()
Returns:
default filename used when downloading action result


Copyright 2007 Ping Identity Corp. All rights reserved.