edu.internet2.middleware.subject.provider
Class JNDISourceAdapter

java.lang.Object
  extended by edu.internet2.middleware.subject.provider.BaseSourceAdapter
      extended by edu.internet2.middleware.subject.provider.JNDISourceAdapter
All Implemented Interfaces:
Source
Direct Known Subclasses:
HelperGrouperJndiSourceAdapter

public class JNDISourceAdapter
extends BaseSourceAdapter

JNDI Source


Constructor Summary
JNDISourceAdapter()
          Allocates new JNDISourceAdapter;
JNDISourceAdapter(String id1, String name1)
          Allocates new JNDISourceAdapter;
 
Method Summary
 void checkConfig()
          make sure the config is ok, and log descriptive errors if not
 Subject getSubject(String id1)
          Deprecated.  
 Subject getSubject(String id1, boolean exceptionIfNull)
          Gets a Subject by its ID.
 Subject getSubjectByIdentifier(String id1)
          Deprecated.  
 Subject getSubjectByIdentifier(String id1, boolean exceptionIfNull)
          note, you should implement this method since this implementation will become abstract at some point
 void init()
          Called by SourceManager when it loads this source.
 String printConfig()
          in the startup on this i2mi app, print helpful and brief info about this source
 Set<Subject> search(String searchValue)
          Unstructured search for Subjects.
 
Methods inherited from class edu.internet2.middleware.subject.provider.BaseSourceAdapter
addAttribute, addInitParam, addSubjectType, equals, getId, getInitParam, getInitParams, getName, getSubjectByIdOrIdentifier, getSubjectsByIdentifiers, getSubjectsByIds, getSubjectsByIdsOrIdentifiers, getSubjectType, getSubjectTypes, hashCode, loadSearch, setId, setName
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JNDISourceAdapter

public JNDISourceAdapter()
Allocates new JNDISourceAdapter;


JNDISourceAdapter

public JNDISourceAdapter(String id1,
                         String name1)
Allocates new JNDISourceAdapter;

Parameters:
id1 -
name1 -
Method Detail

getSubject

public Subject getSubject(String id1,
                          boolean exceptionIfNull)
                   throws SubjectNotFoundException,
                          SubjectNotUniqueException
Description copied from interface: Source
Gets a Subject by its ID.

Specified by:
getSubject in interface Source
Overrides:
getSubject in class BaseSourceAdapter
exceptionIfNull - if SubjectNotFoundException should be throws if the subject is null, or if null should be returned
Returns:
subject
Throws:
SubjectNotFoundException
SubjectNotUniqueException
See Also:
BaseSourceAdapter.getSubject(java.lang.String, boolean)

getSubjectByIdentifier

public Subject getSubjectByIdentifier(String id1,
                                      boolean exceptionIfNull)
                               throws SubjectNotFoundException,
                                      SubjectNotUniqueException
Description copied from class: BaseSourceAdapter
note, you should implement this method since this implementation will become abstract at some point

Specified by:
getSubjectByIdentifier in interface Source
Overrides:
getSubjectByIdentifier in class BaseSourceAdapter
Returns:
subject
Throws:
SubjectNotFoundException
SubjectNotUniqueException
See Also:
BaseSourceAdapter.getSubjectByIdentifier(java.lang.String, boolean)

search

public Set<Subject> search(String searchValue)
Description copied from class: BaseSourceAdapter
Unstructured search for Subjects. Each implementation utilizes its own search algorithm tailored to the Subject repository and schema.

Specified by:
search in interface Source
Specified by:
search in class BaseSourceAdapter
Returns:
set
See Also:
BaseSourceAdapter.search(java.lang.String)

init

public void init()
          throws SourceUnavailableException
Description copied from class: BaseSourceAdapter
Called by SourceManager when it loads this source.

Specified by:
init in interface Source
Specified by:
init in class BaseSourceAdapter
Throws:
SourceUnavailableException
See Also:
BaseSourceAdapter.init()

checkConfig

public void checkConfig()
Description copied from interface: Source
make sure the config is ok, and log descriptive errors if not

See Also:
Source.checkConfig()

printConfig

public String printConfig()
Description copied from interface: Source
in the startup on this i2mi app, print helpful and brief info about this source

Returns:
the info
See Also:
Source.printConfig()

getSubject

@Deprecated
public Subject getSubject(String id1)
                   throws SubjectNotFoundException,
                          SubjectNotUniqueException
Deprecated. 

Description copied from interface: Source
Gets a Subject by its ID.

Specified by:
getSubject in interface Source
Specified by:
getSubject in class BaseSourceAdapter
Returns:
subject
Throws:
SubjectNotFoundException
SubjectNotUniqueException
See Also:
BaseSourceAdapter.getSubject(java.lang.String)

getSubjectByIdentifier

@Deprecated
public Subject getSubjectByIdentifier(String id1)
                               throws SubjectNotFoundException,
                                      SubjectNotUniqueException
Deprecated. 

Description copied from interface: Source
Gets a Subject by other well-known identifiers, aside from the subject ID, for example, login ID.

Specified by:
getSubjectByIdentifier in interface Source
Specified by:
getSubjectByIdentifier in class BaseSourceAdapter
Returns:
subject
Throws:
SubjectNotFoundException
SubjectNotUniqueException
See Also:
BaseSourceAdapter.getSubjectByIdentifier(java.lang.String)