org.kuali.student.admin.messages.service.impl
Class MessageServiceImpl

java.lang.Object
  org.kuali.student.admin.messages.service.impl.MessageServiceImpl

All Implemented Interfaces:

MessageService, InitializingBean

public class MessageServiceImpl
extends Object
implements MessageService, InitializingBean

Field Summary

protected boolean	cachingEnabled
protected com.google.common.cache.Cache<String,MessageList>	msgsCache
protected int	msgsCacheMaxAgeSeconds
protected int	msgsCacheMaxSize

Constructor Summary

MessageServiceImpl()

Method Summary

StatusInfo	addMessage(LocaleInfo localeInfo, String messageGroupKey, MessageInfo messageInfo, ContextInfo contextInfo) Adds a message to the locale and group.
MessageInfo	addMessage(Message messageInfo)
void	afterPropertiesSet()
StatusInfo	deleteMessage(LocaleInfo localeInfo, String messageKey, ContextInfo contextInfo) Deletes the message associated with a locale and group for a message key
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
List<LocaleInfo>	getLocales(ContextInfo contextInfo) Retrieves the list of locales supported by this service.
MessageInfo	getMessage(LocaleInfo localeInfo, String messageGroupKey, String messageKey, ContextInfo contextInfo) Retrieves message information.
List<String>	getMessageGroupKeys(ContextInfo contextInfo) Retrieves the list of message group keys known by the service
MessageGroupKeyList	getMessageGroups()
List<MessageInfo>	getMessages(LocaleInfo localeInfo, String messageGroupKey, ContextInfo contextInfo) Retrieve messages associated with a locale and group.
List<MessageInfo>	getMessagesByGroups(LocaleInfo localeInfo, List<String> messageGroupKeys, ContextInfo contextInfo) Retrieve messages associated with a locale from a specified list of groups.
void	setCachingEnabled(boolean cachingEnabled)
protected MessageInfo	toMessage(MessageEntity entity)
protected MessageEntity	toMessageEntity(Message message)
MessageInfo	updateMessage(LocaleInfo localeInfo, String messageKey, MessageInfo messageInfo, ContextInfo contextInfo) Update message associated with a locale and group.
MessageInfo	updateMessage(LocaleInfo localeInfo, String messageGroupKey, String messageKey, Message messageInfo, ContextInfo contextInfo)

Methods inherited from class java.lang.Object

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

Field Detail

cachingEnabled

protected boolean cachingEnabled

msgsCacheMaxSize

protected int msgsCacheMaxSize

msgsCacheMaxAgeSeconds

protected int msgsCacheMaxAgeSeconds

msgsCache

protected com.google.common.cache.Cache<String,MessageList> msgsCache

Constructor Detail

MessageServiceImpl

public MessageServiceImpl()

Method Detail

addMessage

public StatusInfo addMessage(LocaleInfo localeInfo,
                             String messageGroupKey,
                             MessageInfo messageInfo,
                             ContextInfo contextInfo)
                      throws DoesNotExistException,
                             InvalidParameterException,
                             MissingParameterException,
                             OperationFailedException,
                             PermissionDeniedException

Description copied from interface: MessageService

Adds a message to the locale and group.

Specified by:

addMessage in interface MessageService

Parameters:

localeInfo - the locale information

messageGroupKey - an identifier for the message group

messageInfo - the message information to be added

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the status of the operation. This must always be true.

Throws:

DoesNotExistException - messageGroupKey is not found

InvalidParameterException - localeInfo or contetInfo is not valid

MissingParameterException - localeInfo, messageGroupKey, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

addMessage

public MessageInfo addMessage(Message messageInfo)

getLocales

public List<LocaleInfo> getLocales(ContextInfo contextInfo)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException

Description copied from interface: MessageService

Retrieves the list of locales supported by this service.

Specified by:

getLocales in interface MessageService

Parameters:

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of locales supported by this service

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getMessage

public MessageInfo getMessage(LocaleInfo localeInfo,
                              String messageGroupKey,
                              String messageKey,
                              ContextInfo contextInfo)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException

Description copied from interface: MessageService

Retrieves message information.

Specified by:

getMessage in interface MessageService

Parameters:

localeInfo - the locale information

messageGroupKey - an identifier for the message group to which the message belongs

messageKey - the identifier for the requested message

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the requested message

Throws:

DoesNotExistException - messageGroupKey or messageKey is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - localeInfo, messageGroupKey, messageKey, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

deleteMessage

public StatusInfo deleteMessage(LocaleInfo localeInfo,
                                String messageKey,
                                ContextInfo contextInfo)
                         throws DoesNotExistException,
                                InvalidParameterException,
                                MissingParameterException,
                                OperationFailedException,
                                PermissionDeniedException

Description copied from interface: MessageService

Deletes the message associated with a locale and group for a message key

Specified by:

deleteMessage in interface MessageService

Parameters:

localeInfo - the locale information

messageKey - an identifier for the Message to be deleted

contextInfo - information containing the principalId and information about the caller of service operation

Returns:

the status of the operation. This must always be true.

Throws:

DoesNotExistException - messageKey not found for locale

InvalidParameterException - localeInfo or contextInfo is not valid

MissingParameterException - localeInfo, messageKey, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getMessageGroupKeys

public List<String> getMessageGroupKeys(ContextInfo contextInfo)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: MessageService

Retrieves the list of message group keys known by the service

Specified by:

getMessageGroupKeys in interface MessageService

Parameters:

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of message group keys

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getMessageGroups

public MessageGroupKeyList getMessageGroups()

getMessages

public List<MessageInfo> getMessages(LocaleInfo localeInfo,
                                     String messageGroupKey,
                                     ContextInfo contextInfo)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Description copied from interface: MessageService

Retrieve messages associated with a locale and group.

Specified by:

getMessages in interface MessageService

Parameters:

localeInfo - the locale information

messageGroupKey - an identifier for the message group to which the messages belong

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of Messages

Throws:

DoesNotExistException - messageGroupKey is not found

InvalidParameterException - loacleInfo or contextInfo is not valid

MissingParameterException - localeInfo, messageGroupKey, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getMessagesByGroups

public List<MessageInfo> getMessagesByGroups(LocaleInfo localeInfo,
                                             List<String> messageGroupKeys,
                                             ContextInfo contextInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Description copied from interface: MessageService

Retrieve messages associated with a locale from a specified list of groups.

Specified by:

getMessagesByGroups in interface MessageService

Parameters:

localeInfo - the locale information

messageGroupKeys - a list of identifiers for the message groups

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the list of Messages belonging to the list of message groups

Throws:

DoesNotExistException - localeInfo or a messageGroupKey in messageGroupKeys is not found

InvalidParameterException - localeInfo or contextInfo is not valid

MissingParameterException - localeInfo, messageGroupKeys, a messageGroupKey in messagegroupKey, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

updateMessage

public MessageInfo updateMessage(LocaleInfo localeInfo,
                                 String messageKey,
                                 MessageInfo messageInfo,
                                 ContextInfo contextInfo)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException,
                                 ReadOnlyException,
                                 VersionMismatchException

Description copied from interface: MessageService

Update message associated with a locale and group.

Specified by:

updateMessage in interface MessageService

Parameters:

localeInfo - the locale information

messageKey - the indentifier for the message

messageInfo - the message information to be updated

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

message information

Throws:

DoesNotExistException - messageKey is not found

InvalidParameterException - localeInfo, messageInfo, or contextInfo is not valid

MissingParameterException - localeInfo, messageKey, messageInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at supplying information designated as read only

VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

updateMessage

public MessageInfo updateMessage(LocaleInfo localeInfo,
                                 String messageGroupKey,
                                 String messageKey,
                                 Message messageInfo,
                                 ContextInfo contextInfo)

toMessageEntity

protected MessageEntity toMessageEntity(Message message)

toMessage

protected MessageInfo toMessage(MessageEntity entity)

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

setCachingEnabled

public void setCachingEnabled(boolean cachingEnabled)