com.nkasenides.athlos.model.IWorldSession Maven / Gradle / Ivy

Go to download
package com.nkasenides.athlos.model;

/**
 * Abstracts the functionality of world sessions.
 */
public interface IWorldSession {

    /**
     * Retrieves the world session's ID.
     * @return Returns a string-based ID.
     */
    String getId();

    /**
     * Retrieves the world session's player's ID.
     * @return Returns a string-based ID.
     */
    String getPlayerID();

    /**
     * Retrieves the IP address of this session.
     * @return Returns a string-formatted IP address.
     */
    String getIpAddress();

    /**
     * Retrieves the creation time of this session.
     * @return Returns UNIX timestamp as a long.
     */
    long getCreatedOn();

    /**
     * Retrieves the expiration time of this session.
     * @return Returns a UNIX timestamp as a long.
     */
    long getExpiresOn();

    /**
     * Retrieves the ID of the world of this session.
     * @return Returns a string-based ID.
     */
    String getWorldID();

}