|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CommunicationService
An utility class to create objects that are not related to a CommunicationSession, for example groups.
Field Summary | |
---|---|
static String |
NAME
Name of the HTTP session attribute to retrieve an instance of CommunicationService. |
Method Summary | ||
---|---|---|
Group |
createGroup(String groupName,
String uid)
Creates an empty group for a user. |
|
Group |
createGroup(String groupName,
String uid,
Map<String,String> buddyList)
Creates a group for a user with a number of buddies. |
|
ProxyAuthentication |
createProxyAuthentication(String domain,
String userid,
String password)
Creates a proxy authentication for a registration. |
|
void |
createRuleSetFromTemplate(String uid,
RuleSetType type)
Create a rules set and shared list according to the specified template. |
|
void |
deleteRuleSetFromTemplate(String uid)
Deletes all the rules from the rule set. |
|
|
findByInitiator(Class<C> type,
String initiator)
Search for all communication initiated by a particular user. |
|
|
findByName(Class<C> type,
String name)
Search API for communication by name. |
|
|
findByParticipant(Class<C> type,
String participantName)
Search for all communication where a particular user is present. |
|
|
findCommunications(Class<C> type)
Method that returns all the communications for that application depending on the type of communication, |
|
Group |
getGroup(String uid,
String groupName)
Returns the group for the specified user and group name. |
|
List<Group> |
getGroups(String uid)
returns the list of groups for the specified user. |
|
RuleSetType |
getRuleSetType(String uid)
Attempts to determine the ruleset type. |
Field Detail |
---|
static final String NAME
Method Detail |
---|
void createRuleSetFromTemplate(String uid, RuleSetType type)
type
- the type of ruleset and corresponding shared lists that are created.void deleteRuleSetFromTemplate(String uid)
RuleSetType getRuleSetType(String uid)
Group createGroup(String groupName, String uid, Map<String,String> buddyList)
groupName
- the name of the group, unique for this useruid
- the URI of the owner of the group.buddlist
- List of the buddies to be inserted.
Each of the entries in the buddy list have the buddy's
user ID as key and the buddy's display name as value.
IllegalStateException
- if the RCS ruleset template is used and a list other then "rcs" would be createdGroup createGroup(String groupName, String uid)
groupName
- the name of the group, unique for this useruid
- the URI of the owner of the group.
IllegalStateException
- if the RCS ruleset template is used and a list other then "rcs" would be createdGroup getGroup(String uid, String groupName)
uid
- the URI of the owner of the group.groupName
- the name of the wanted group
List<Group> getGroups(String uid)
uid
- the URI of the owner of the group.
ProxyAuthentication createProxyAuthentication(String domain, String userid, String password)
domain
- the name of the realm for which credentials are needed.userid
- the userid.password
- the password necessary for this realm.
<C extends Communication> Collection<C> findCommunications(Class<C> type)
C
- Communication. Can be conversation, conference..type
- Type of the Communication class.
<C extends Communication> C findByName(Class<C> type, String name)
C
- communicationtype
- type of communicationname
- name of the communication
<C extends Communication> Collection<C> findByInitiator(Class<C> type, String initiator)
C
- type of communicationtype
- communication classinitiator
- Caller of the communication.
<C extends Communication> Collection<C> findByParticipant(Class<C> type, String participantName)
C
- Communicationtype
- type of communicationparticipantName
- name of the participant
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |