com.netbout.spi.Aliases Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2016, netbout.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are PROHIBITED without prior written permission from
* the author. This product may NOT be used anywhere and on any computer
* except the server platform of netbout Inc. located at www.netbout.com.
* Federal copyright law prohibits unauthorized reproduction by any means
* and imposes fines up to $25,000 for violation. If you received
* this code accidentally and without intent to use it, please report this
* incident to the author by email.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
package com.netbout.spi;
import com.jcabi.aspects.Immutable;
import java.io.IOException;
/**
* User of the system.
*
* @author Yegor Bugayenko ([email protected])
* @version $Id: 5f5a6b12168d55bc57bf30e3686e2b88c099fc42 $
* @since 2.0
*/
@Immutable
public interface Aliases {
/**
* Is it possible to assign this identity?
* @param name Alias to assign
* @return Empty string if it's available, message otherwise
* @throws IOException If fails
*/
String check(String name) throws IOException;
/**
* Try to assign this new identity to this user.
* @param name Alias to assign
* @return New Alias instance.
* @throws IOException If fails
*/
Alias add(String name) throws IOException;
/**
* Iterate them all.
* @return List of all aliases
* @throws IOException If fails
*/
Iterable iterate() throws IOException;
}