com.esri.adf.security.store
Class ConnectParams

java.lang.Object
  com.esri.adf.security.store.ConnectParams

Direct Known Subclasses:

ADConnectParams, DBConnectParams, LDAPConnectParams

public abstract class ConnectParams
extends java.lang.Object

This class forms the parent class for all classes that contain connection parameters to a particular data store. When writing custom implementations of the SecurityStore interface, you can inherit from this class to write custom connection parameter object that you can pass on to your SecurityStore interface custom implementation.

Field Summary

protected java.lang.String

type

Constructor Summary

ConnectParams()

Method Summary

abstract java.util.Map<java.lang.String,java.lang.String>	getParameters() Returns the parameters set on the object into a HashMap
abstract java.lang.String	getType() Returns a string identifier for the class that implements this method.
abstract void	setParameters(java.util.Map<java.lang.String,java.lang.String> paramsMap) Populates the parameters from the HashMap
abstract boolean	verifyParameters() Verifies that the parameters set on the object are valid

Methods inherited from class java.lang.Object

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

Field Detail

type

protected java.lang.String type

Constructor Detail

ConnectParams

public ConnectParams()

Method Detail

getType

public abstract java.lang.String getType()

Returns a string identifier for the class that implements this method.

Returns:

String identifier for the implementing class

verifyParameters

public abstract boolean verifyParameters()
                                  throws ArcGISSecurityException

Verifies that the parameters set on the object are valid

Returns:

true if the parameters are valid

Throws:

ArcGISSecurityException - - if any of the required parameters are not set

setParameters

public abstract void setParameters(java.util.Map<java.lang.String,java.lang.String> paramsMap)
                            throws ArcGISSecurityException

Populates the parameters from the HashMap

Parameters:

paramsMap - - HashMap that contains the names of the parameter and their values

Throws:

ArcGISSecurityException - - if the required parameters are not set

getParameters

public abstract java.util.Map<java.lang.String,java.lang.String> getParameters()
                                                                        throws ArcGISSecurityException

Returns the parameters set on the object into a HashMap

Returns:

HashMap containing the parameters and their values

Throws:

ArcGISSecurityException - - if the required parameters are not set