Debian Codegraph @

src/java/org/astrogrid/samp/hub/ProfileToken.java

raw
1 package org.astrogrid.samp.hub;
2
3 /**
4 * Marker interface that identifies a hub profile.
5 * Objects implementing this interface can be identified as the provider of
6 * a connection to the hub.
7 *
8 * @author Mark Taylor
9 * @since 20 Jul 2011
10 */
11 public interface ProfileToken {
12
13 /**
14 * Returns the name by which this token is to be identified.
15 *
16 * @return profile identifier, usually one word
17 */
18 String getProfileName();
19
20 /**
21 * Returns a MessageRestriction object which controls what messages
22 * may be sent by clients registering under ths profile.
23 * If null is returned, any messages may be sent.
24 *
25 * @return message restriction, or null
26 */
27 MessageRestriction getMessageRestriction();
28 }