netbout-spi-1.5.9.src.main.java.com.netbout.spi.Identity Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2012, Netbout.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the NetBout.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* 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 HOLDER 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.urn.URN;
import java.net.URL;
import java.util.Set;
/**
* The identity of the person in a bout.
*
* Identities are comparable by their names.
*
*
Instances of this interface must be thread-safe.
*
* @author Yegor Bugayenko ([email protected])
* @version $Id: Identity.java 3668 2012-11-18 12:52:15Z guard $
*/
public interface Identity extends Friend {
/**
* Thowable when bout is not found.
* @see Identity#bout(Long)
*/
class BoutNotFoundException extends Exception {
/**
* Serialization marker.
*/
private static final long serialVersionUID = 0x7526FA78EED21470L;
/**
* Public ctor.
* @param num The number of bout not found
*/
public BoutNotFoundException(final Long num) {
super(String.format("Bout #%d not found", num));
}
}
/**
* Thowable when URN can't be reached by the system anyhow.
* @see Identity#friend(URN)
*/
class UnreachableURNException extends Exception {
/**
* Serialization marker.
*/
private static final long serialVersionUID = 0x7526FA78EFD214F0L;
/**
* Public ctor.
* @param urn The URN
* @param cause The cause of the exception
*/
public UnreachableURNException(final URN urn, final String cause) {
super(String.format("%s: '%s'", cause, urn));
}
/**
* Public ctor.
* @param urn The URN
* @param cause The cause of the exception
*/
public UnreachableURNException(final URN urn, final Throwable cause) {
super(urn.toString(), cause);
}
}
/**
* How many milliseconds we should way before this object becomes fully
* available for requests (if you make a request earlier you may receive
* invalid data or even a runtime exception).
* @return The number of milliseconds we recommend to wait before making
* any manipulations with this object (and all other child objects, like
* its bouts, messages, etc.)
*/
Long eta();
/**
* Who validated this user.
* @return The URL of the authority
*/
URL authority();
/**
* Start new bout.
* @return The bout just created
*/
Bout start();
/**
* Get an ordered list of all bouts this identity is taking
* participation in.
* @param query Search query, if necessary
* @return The list of bouts
*/
Iterable inbox(Query query);
/**
* Get bout by its unique ID.
* @param number The number of the bout
* @return The bout
* @throws Identity.BoutNotFoundException If this bout doesn't exist
*/
Bout bout(Long number) throws Identity.BoutNotFoundException;
/**
* Find another identity by name.
* @param name Unique name of identity
* @return The identity just found
* @throws Identity.UnreachableURNException If such
* a friend can't be reached
*/
Friend friend(URN name) throws Identity.UnreachableURNException;
/**
* Find friends by keyword.
* @param keyword The keyword
* @return The list of identities found
*/
Set friends(String keyword);
/**
* Get profile.
* @return The profile of this identity
*/
OwnProfile profile();
}