edu.internet2.middleware.grouperClient.api

Class GcLdapSearchAttribute

java.lang.Object

edu.internet2.middleware.grouperClient.api.GcLdapSearchAttribute

public class GcLdapSearchAttribute
extends Object

Generate an ldap call and get results. Note, you can only call the result methods once since the enumeration will be done.

Author:

mchyzer

Constructor Summary

Constructors

Constructor and Description
GcLdapSearchAttribute()

Method Summary

Methods

Modifier and Type	Method and Description
GcLdapSearchAttribute	addMatchingAttribute(String attributeName, String attributeValue) add a matching attribute
GcLdapSearchAttribute	addReturningAttribute(String returningAttribute) add an attribute to return
GcLdapSearchAttribute	assignLdapName(String theName) assign the name
void	copyFrom(GcLdapSearchAttribute gcLdapSearchAttribute) copy from the argument to this object
void	execute() execute the call
static GcLdapSearchAttribute	executeHelper(GcLdapSearchAttribute input, String url) execute the call
String	getMatchingAttribute(String matchingAttributeName) get a matching attribute value
String	retrieveResultAttributeString()
List<String>	retrieveResultAttributeStringList() retrieve attribute list
boolean	retrieveResultAttributeStringMatch(String valueToMatch) see if the attribute value matches a certain value
String	toString()
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

GcLdapSearchAttribute

public GcLdapSearchAttribute()

Method Detail

copyFrom

public void copyFrom(GcLdapSearchAttribute gcLdapSearchAttribute)

copy from the argument to this object

Parameters:

gcLdapSearchAttribute -

retrieveResultAttributeString

public String retrieveResultAttributeString()

Returns:

string

retrieveResultAttributeStringMatch

public boolean retrieveResultAttributeStringMatch(String valueToMatch)

see if the attribute value matches a certain value

Parameters:

valueToMatch -

Returns:

true if matches this value

retrieveResultAttributeStringList

public List<String> retrieveResultAttributeStringList()

retrieve attribute list

Returns:

the attributes

getMatchingAttribute

public String getMatchingAttribute(String matchingAttributeName)

get a matching attribute value

Parameters:

matchingAttributeName -

Returns:

the attribute

addMatchingAttribute

public GcLdapSearchAttribute addMatchingAttribute(String attributeName,
                                         String attributeValue)

add a matching attribute

Parameters:

attributeName -

attributeValue -

Returns:

this for chaining

addReturningAttribute

public GcLdapSearchAttribute addReturningAttribute(String returningAttribute)

add an attribute to return

Parameters:

returningAttribute -

Returns:

the ldap call for chaining

validate

public void validate()

execute

public void execute()

execute the call

executeHelper

public static GcLdapSearchAttribute executeHelper(GcLdapSearchAttribute input,
                                  String url)

execute the call

Parameters:

input - fields from the input

url -

Returns:

the instance to copy from

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

assignLdapName

public GcLdapSearchAttribute assignLdapName(String theName)

assign the name

Parameters:

theName -

Returns:

this for chaining