weblogic.management.utils
Interface ListerMBean

All Superinterfaces:

DescriptorBean, SettableBean, StandardInterface

All Known Subinterfaces:

ActiveDirectoryAuthenticatorMBean, CertificateRegistryMBean, CertRegManagerMBean, DefaultAuthenticatorMBean, DefaultAuthorizerMBean, DefaultCredentialMapperMBean, DefaultRoleMapperMBean, GroupCertRegManagerMBean, GroupEditorMBean, GroupMemberListerMBean, GroupReaderMBean, GroupUserListerMBean, IPlanetAuthenticatorMBean, LDAPAuthenticatorMBean, MemberGroupListerMBean, NameListerMBean, NovellAuthenticatorMBean, OpenLDAPAuthenticatorMBean, OracleInternetDirectoryAuthenticatorMBean, OracleVirtualDirectoryAuthenticatorMBean, PKICredentialMapEditorMBean, PKICredentialMapperMBean, PKICredentialMapReaderMBean, PolicyListerMBean, PolicyStoreMBean, PropertiesListerMBean, ReadOnlySQLAuthenticatorMBean, RoleListerMBean, SAML2CredentialMapperMBean, SAML2IdentityAsserterMBean, SAML2IdPPartnerRegistryMBean, SAML2PartnerRegistryMBean, SAML2SPPartnerRegistryMBean, SAMLAssertingPartyRegistryMBean, SAMLCredentialMapperV2MBean, SAMLIdentityAsserterMBean, SAMLIdentityAsserterV2MBean, SAMLPartnerRegistryMBean, SAMLRelyingPartyRegistryMBean, SQLAuthenticatorMBean, UserEditorMBean, UserPasswordCredentialMapEditorMBean, UserPasswordCredentialMapExtendedReaderMBean, UserPasswordCredentialMapReaderMBean, UserReaderMBean, WindowsNTAuthenticatorMBean

public interface ListerMBean
extends StandardInterface, DescriptorBean

The ListerMBean interface provides a general mechanism for returning lists.

Derived MBeans extend this interface to add methods that access the data of the current object in the list. This is different from the iterator model (where the next method returns the next object in the list) because creating MBeans for each object returned in a list (for example, one MBean per user) is too expensive. In addition, it is not appropriate to return non-MBean or non-primitive types from an MBean.

The general iteration pattern is as follows:

FooListerMBean fooLister = ...;
String cursor = lister.listFoo(...);
try {
while (fooLister.haveCurrent(cursor)) {
Foo currentVal = fooLister.getCurrentFoo(cursor);
fooLister.advance(cursor);
}
} finally { fooLister.close(cursor);


haveCurrent

boolean haveCurrent(String cursor)
                    throws InvalidCursorException

Returns true if there are more objects in the list, and false otherwise.

Parameters:

cursor - - The cursor returned from a previous list method.

Throws:

InvalidCursorException

advance

void advance(String cursor)
             throws InvalidCursorException

Advances the list to the next element in the list.

Parameters:

cursor - - The cursor returned from a previous list method.

Throws:

InvalidCursorException

close

void close(String cursor)
           throws InvalidCursorException

Indicates that the caller is finished using the list, and that the resources held on behalf of the list may be released. If the caller traverses through all the elements in the list, the caller need not call this method. In other words, it is used to let the caller close the list without reading each element that is returned.

Parameters:

cursor - - The cursor returned from a previous list method.

Throws:

InvalidCursorException