com.smartfoxserver.v2.entities.invitation

Class SFSInvitationManager

java.lang.Object

com.smartfoxserver.v2.entities.invitation.SFSInvitationManager

All Implemented Interfaces:

com.smartfoxserver.bitswarm.service.IService, InvitationManager

public class SFSInvitationManager
extends java.lang.Object
implements com.smartfoxserver.bitswarm.service.IService, InvitationManager

Field Summary

Fields

Modifier and Type	Field and Description
protected IDGenerator	idGen
protected java.util.Map<java.lang.Integer,Invitation>	invitationsById
protected java.util.Map<User,java.util.List<Invitation>>	invitationsByOwner
protected org.slf4j.Logger	log
protected int	maxInvitationsPerUser
protected java.lang.String	serviceName
protected SmartFoxServer	sfs

Constructor Summary

Constructors

Constructor and Description
SFSInvitationManager()

Method Summary

Modifier and Type	Method and Description
void	destroy(java.lang.Object o) Destroy service
Invitation	findById(int id) Find an invitation from its id
IDGenerator	getIDGenerator()
int	getMaxInvitationsPerUser()
java.lang.String	getName() Get the service name
protected void	handleAcceptedInvitation(Invitation invitation, ISFSObject params)
void	handleMessage(java.lang.Object o) Send message to service
protected void	handleRefusedInvitation(Invitation invitation, ISFSObject params)
void	init(java.lang.Object o) Initialize service
protected void	initCleanUpTask()
void	onInvitationResult(int invitationId, InvitationResponse result, ISFSObject params) Handle the response to an invitation
void	onInvitationResult(Invitation invitation, InvitationResponse result, ISFSObject params) Handle the response to an invitation
protected java.util.List<Invitation>	prepareStartInvitation(Invitation invitation, InvitationCallback callBack)
protected void	removeInvitation(Invitation invitation)
void	setMaxInvitationsPerUser(int value)
void	setName(java.lang.String name) Set the service name
void	startInvitation(Invitation invitation, InvitationCallback callBack) Start a new invitation
void	suppressInvitation(Invitation invitation) Stop an invitation that is running

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serviceName

protected java.lang.String serviceName

sfs

protected final SmartFoxServer sfs

log

protected final org.slf4j.Logger log

invitationsById

protected final java.util.Map<java.lang.Integer,Invitation> invitationsById

invitationsByOwner

protected final java.util.Map<User,java.util.List<Invitation>> invitationsByOwner

maxInvitationsPerUser

protected int maxInvitationsPerUser

idGen

protected IDGenerator idGen

Constructor Detail

SFSInvitationManager

public SFSInvitationManager()

Method Detail

init

public void init(java.lang.Object o)

Description copied from interface: com.smartfoxserver.bitswarm.service.IService

Initialize service

Specified by:

init in interface com.smartfoxserver.bitswarm.service.IService

Parameters:

o - custom parameters

destroy

public void destroy(java.lang.Object o)

Description copied from interface: com.smartfoxserver.bitswarm.service.IService

Destroy service

Specified by:

destroy in interface com.smartfoxserver.bitswarm.service.IService

Parameters:

o - custom parameters

getName

public java.lang.String getName()

Description copied from interface: com.smartfoxserver.bitswarm.service.IService

Get the service name

Specified by:

getName in interface com.smartfoxserver.bitswarm.service.IService

Returns:

the service name

setName

public void setName(java.lang.String name)

Description copied from interface: com.smartfoxserver.bitswarm.service.IService

Set the service name

Specified by:

setName in interface com.smartfoxserver.bitswarm.service.IService

Parameters:

name - the service name

handleMessage

public void handleMessage(java.lang.Object o)

Description copied from interface: com.smartfoxserver.bitswarm.service.IService

Send message to service

Specified by:

handleMessage in interface com.smartfoxserver.bitswarm.service.IService

Parameters:

o - the message

findById

public Invitation findById(int id)

Description copied from interface: InvitationManager

Find an invitation from its id

Specified by:

findById in interface InvitationManager

Returns:

the invitation object

getMaxInvitationsPerUser

public int getMaxInvitationsPerUser()

Specified by:

getMaxInvitationsPerUser in interface InvitationManager

Returns:

the max amount of invitations a User can run simultaneously

setMaxInvitationsPerUser

public void setMaxInvitationsPerUser(int value)

Specified by:

setMaxInvitationsPerUser in interface InvitationManager

Parameters:

value - the max amount of invitations a User can run simultaneously

startInvitation

public void startInvitation(Invitation invitation,
                            InvitationCallback callBack)

Description copied from interface: InvitationManager

Start a new invitation

Specified by:

startInvitation in interface InvitationManager

Parameters:

invitation - the invitation object

callBack - the response handler

prepareStartInvitation

protected java.util.List<Invitation> prepareStartInvitation(Invitation invitation,
                                                            InvitationCallback callBack)

suppressInvitation

public void suppressInvitation(Invitation invitation)

Description copied from interface: InvitationManager

Stop an invitation that is running

Specified by:

suppressInvitation in interface InvitationManager

Parameters:

invitation - the invitation

onInvitationResult

public void onInvitationResult(int invitationId,
                               InvitationResponse result,
                               ISFSObject params)
                        throws SFSInvitationException

Description copied from interface: InvitationManager

Handle the response to an invitation

Specified by:

onInvitationResult in interface InvitationManager

Parameters:

invitationId - the id of the invitation

result - the result

params - optional params

Throws:

SFSInvitationException

onInvitationResult

public void onInvitationResult(Invitation invitation,
                               InvitationResponse result,
                               ISFSObject params)
                        throws SFSInvitationException

Description copied from interface: InvitationManager

Handle the response to an invitation

Specified by:

onInvitationResult in interface InvitationManager

Parameters:

invitation - the invitation

result - the result

params - optional params

Throws:

SFSInvitationException

getIDGenerator

public IDGenerator getIDGenerator()

Specified by:

getIDGenerator in interface InvitationManager

initCleanUpTask

protected void initCleanUpTask()

handleAcceptedInvitation

protected void handleAcceptedInvitation(Invitation invitation,
                                        ISFSObject params)

handleRefusedInvitation

protected void handleRefusedInvitation(Invitation invitation,
                                       ISFSObject params)

removeInvitation

protected void removeInvitation(Invitation invitation)