com.sshtools.profile
Interface SchemeOptions

All Known Implementing Classes:

AbstractSshSchemeOptions

public interface SchemeOptions

To allow each connection scheme to have its own protocol specific options, a ResourceProfile can have a single SchemeOptions implementation.

When the ResourceProfile XML file is being parsed and a SchemeOptions element is encountered, the className attribute is used to instantiate a class that implements this interface. All child elements are then passed to the instance so the it can build up its properties.

Version:

$Revision: 1.1 $

Author:

$Author: richard $

Method Summary

nanoxml.XMLElement	getElement() Get these options as an XML element that can be persisted along with the ResourceProfile.
void	init(nanoxml.XMLElement element) Invoked when instantiated by the ResourceProfile parser or when creating a new profile.
boolean	isAppropriateForScheme(java.lang.String schemeName) Return if these options are appropriate for a scheme

Method Detail

init

public void init(nanoxml.XMLElement element)
          throws ProfileException

Invoked when instantiated by the ResourceProfile parser or when creating a new profile. If null is provided as the element, default options will be set.

Parameters:

element - SchemeOptions element

Throws:

ProfileException - if any data provided by the element is invalid

getElement

public nanoxml.XMLElement getElement()

Get these options as an XML element that can be persisted along with the ResourceProfile.

Returns:

XML element for persisting along with the ResourceProfile

isAppropriateForScheme

public boolean isAppropriateForScheme(java.lang.String schemeName)

Return if these options are appropriate for a scheme

Parameters:

schemeName -

Returns:

true if these options are appropriate for a scheme