org.wildfly.security.auth.server.ModifiableRealmIdentityIterator Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* JBoss, Home of Professional Open Source.
* Copyright 2016 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wildfly.security.auth.server;
import java.util.Iterator;
/**
* An iterator over realm identities. The iterator should be closed in order to release any associated
* resources.
*
* @author Jan Kalina
*/
public interface ModifiableRealmIdentityIterator extends Iterator, AutoCloseable {
/**
* Close any underlying resources. No need to call if end of sequence already occurred.
*/
default void close() throws RealmUnavailableException {}
/**
* Returns an iterator that has no elements and is closeable.
*
* @return empty closeable iterator
*/
static ModifiableRealmIdentityIterator emptyIterator() {
return new ModifiableRealmIdentityIterator() {
@Override
public boolean hasNext() {
return false;
}
@Override
public ModifiableRealmIdentity next() {
return null;
}
};
}
}