|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NotificationService
Method Summary | |
---|---|
long |
addLocaleToTemplate(long templateid, java.util.Locale locale, java.util.HashMap mapLocaleTemplate) Add a new localized template to the existing notification template |
long |
addLocaleToTemplate(java.lang.String templateNameString, java.util.Locale locale, java.util.HashMap mapLocaleTemplate) Add a new localized template to the existing notification template |
long |
addTemplate(NotificationTemplate template) Add a new template in OIM Repository |
long |
addTemplate(java.lang.String eventName, java.lang.String templatename, java.lang.String description, boolean snmpSupported) Add a new template in OIM Repository |
long |
deleteTemplate(long templateid, java.util.Date timestamp) Removes a template from repository based on template ID |
long |
deleteTemplate(java.lang.String templateName, java.util.Date timestamp) Removes a template from repository based on template name |
java.util.List |
getAvailableData(java.lang.String eventType, java.util.Map map) To retrieve the available data associated with an event |
EventXMLObject |
getEventDetails(java.lang.String eventType) To get event details specific to a given event-type It aims to retrieve the dynamic parameters related to an event |
java.util.List |
getEventList() Retrieve list of all the notification events existing in the system |
java.util.Set |
getListedNotificationProviders() Get all the notification providers |
java.util.List |
getStaticData(java.lang.String eventType) To retrieve static data associated with an event |
NotificationTemplate |
lookupTemplate(long templateid, java.util.Locale locale) Retrieves a template based on given templateid and locale |
NotificationTemplate |
lookupTemplate(java.lang.String templateName, java.util.Locale locale) Retrieves a template based on given template name and locale |
long |
modifyTemplate(long templateid, java.util.HashMap values, java.util.Locale locale, java.util.Date timestamp) Modifies an existing template |
long |
modifyTemplate(java.lang.String templateName, java.util.HashMap values, java.util.Locale locale, java.util.Date timestamp) Modifies an existing template |
boolean |
notify(NotificationEvent event) Notifies a user/system against the event passed. |
boolean |
notify(NotificationEvent event, java.lang.String providerName) Notifies a user/system against the event passed. |
long |
removeLocalefromTemplate(long templateid, java.util.Locale locale, java.util.Date timestamp) Remove a specific locale support from a template |
long |
removeLocalefromTemplate(java.lang.String templateName, java.util.Locale locale, java.util.Date timestamp) Remove a specific locale support from a template |
java.util.List |
search(SearchCriteria criteria, java.util.Set retAttrs, java.util.HashMap configParams) Retrieves list of templates based on the search criteria |
java.util.List |
search(SearchCriteria criteria, java.util.Set retAttrs, java.util.HashMap configParams, java.util.Map resBundleMap) Retrieves list of templates based on the search criteria |
java.util.List |
searchTemplate(SearchCriteria searchCriteria, long start, long end) Retrieves list of templates based on the search criteria |
Method Detail |
---|
long addTemplate(NotificationTemplate template) throws TemplateAlreadyExistsException, NotificationManagementException
template
- Notification Template to be savedTemplateAlreadyExistsException
NotificationManagementException
long addTemplate(java.lang.String eventName, java.lang.String templatename, java.lang.String description, boolean snmpSupported) throws TemplateAlreadyExistsException, NotificationManagementException
eventName
- Name of the event to which the template is to be associatedtemplatename
- Name of the Templatedescription
- Description of the TemplatesnmpSupported
- boolean to specify if SNMP is supported or notTemplateAlreadyExistsException
NotificationManagementException
long addLocaleToTemplate(java.lang.String templateNameString, java.util.Locale locale, java.util.HashMap mapLocaleTemplate) throws TemplateNotFoundException, MultipleTemplateException, NotificationManagementException
templateNameString
- name of the template where new locale support is being addedlocale
- LocalemapLocaleTemplate
- Hashmap of attribute names and corresponding values keys' name of HashMap: "SHORTMESSAGEBODY" "LONGMESSAGEBODY" "MESSAGESUBJECT" "ENCODING" "TYPE"TemplateNotFoundException
MultipleTemplateException
NotificationManagementException
long addLocaleToTemplate(long templateid, java.util.Locale locale, java.util.HashMap mapLocaleTemplate) throws TemplateNotFoundException, NotificationManagementException
templateid
- id of the template where new locale support is being addedlocale
- LocalemapLocaleTemplate
- Hashmap of attribute names and corresponding values keys' name of HashMap: "SHORTMESSAGEBODY" "LONGMESSAGEBODY" "MESSAGESUBJECT" "ENCODING" "TYPE"TemplateNotFoundException
NotificationManagementException
java.util.List searchTemplate(SearchCriteria searchCriteria, long start, long end) throws InvalidSearchOptionException, NotificationManagementException
searchCriteria
- For specifying searchcriteria use templatename, eventname and locale as parameters only. By default, the results will be sorted based on id column. Calls can be made in the following manner SearchCriteria sc1 = new SearchCriteria("templateName", templateName, SearchCriteria.Operator.EQUAL); SearchCriteria sc2 = new SearchCriteria("eventName", eventName, SearchCriteria.Operator.EQUAL); SearchCriteria sc3 = new SearchCriteria("locale", locale, SearchCriteria.Operator.EQUAL); SearchCriteria sc4 = new SearchCriteria(sc1, sc2, SearchCriteria.Operator.AND); SearchCriteria sc5 = new SearchCriteria(sc4, sc3, SearchCriteria.Operator.AND); long start=1, end=4; List<SearchResult> list = notificationService.searchTemplate(sc5, start, end);start
- specifies starting of the subset of the complete search result to be fetchedend
- specifies end of the subset of the complete search result to be fetchedInvalidSearchOptionException
NotificationManagementException
NotificationTemplate lookupTemplate(long templateid, java.util.Locale locale) throws TemplateNotFoundException, MultipleTemplateException, NotificationManagementException
templateid
- id of the template for which data is to be loadedlocale
- LocaleTemplateNotFoundException
MultipleTemplateException
NotificationManagementException
NotificationTemplate lookupTemplate(java.lang.String templateName, java.util.Locale locale) throws TemplateNotFoundException, MultipleTemplateException, NotificationManagementException
templateName
- name of the template for which data is to be loadedlocale
- LocaleTemplateNotFoundException
MultipleTemplateException
NotificationManagementException
long deleteTemplate(long templateid, java.util.Date timestamp) throws TemplateNotFoundException, NotificationManagementException, LastModifyDateNotSetException, oracle.iam.platform.kernel.StaleDataException, MultipleTemplateException
templateid
- id of the template to be deletedtimestamp
- last timestamp for the templateTemplateNotFoundException
LastModifyDateNotSetException
oracle.iam.platform.kernel.StaleDataException
NotificationManagementException
MultipleTemplateException
long deleteTemplate(java.lang.String templateName, java.util.Date timestamp) throws TemplateNotFoundException, MultipleTemplateException, NotificationManagementException, LastModifyDateNotSetException, oracle.iam.platform.kernel.StaleDataException
templateName
- name of the template to be deletedtimestamp
- last timestamp for the templateTemplateNotFoundException
MultipleTemplateException
NotificationManagementException
LastModifyDateNotSetException
oracle.iam.platform.kernel.StaleDataException
long removeLocalefromTemplate(long templateid, java.util.Locale locale, java.util.Date timestamp) throws TemplateNotFoundException, NotificationManagementException, MultipleTemplateException, LastModifyDateNotSetException, oracle.iam.platform.kernel.StaleDataException
templateid
- id of the template to be deletedlocale
- Localetimestamp
- Will be used for Optimistic LockingTemplateNotFoundException
MultipleTemplateException
LastModifyDateNotSetException
NotificationManagementException
oracle.iam.platform.kernel.StaleDataException
long removeLocalefromTemplate(java.lang.String templateName, java.util.Locale locale, java.util.Date timestamp) throws TemplateNotFoundException, MultipleTemplateException, NotificationManagementException, LastModifyDateNotSetException, oracle.iam.platform.kernel.StaleDataException
templateName
- name of the template to be deletedlocale
- Localetimestamp
- Will be used for Optimistic LockingMultipleTemplateException
TemplateNotFoundException
LastModifyDateNotSetException
NotificationManagementException
oracle.iam.platform.kernel.StaleDataException
long modifyTemplate(long templateid, java.util.HashMap values, java.util.Locale locale, java.util.Date timestamp) throws TemplateNotFoundException, MultipleTemplateException, NotificationManagementException, LastModifyDateNotSetException, oracle.iam.platform.kernel.StaleDataException
templateid
- id of the notification templatevalues
- Hashmap of attribute names and corresponding new valueslocale
- Locale, needed if any parameter specific to the local associated with the template is to be modified. If is null, then only parameters associated with the template can be modifiedtimestamp
- Will be used for Optimistic LockingMultipleTemplateException
TemplateNotFoundException
NotificationManagementException
LastModifyDateNotSetException
oracle.iam.platform.kernel.StaleDataException
long modifyTemplate(java.lang.String templateName, java.util.HashMap values, java.util.Locale locale, java.util.Date timestamp) throws TemplateNotFoundException, MultipleTemplateException, NotificationManagementException, LastModifyDateNotSetException, oracle.iam.platform.kernel.StaleDataException
templateName
- name of the notification templatevalues
- Hashmap of attribute names and corresponding new valueslocale
- Locale, needed if any parameter specific to the local associated with the template is to be modified. If is null, then only parameters associated with the template can be modifiedtimestamp
- Will be used for Optimistic LockingMultipleTemplateException
TemplateNotFoundException
LastModifyDateNotSetException
NotificationManagementException
oracle.iam.platform.kernel.StaleDataException
boolean notify(NotificationEvent event) throws EventException, UnresolvedNotificationDataException, TemplateNotFoundException, MultipleTemplateException, NotificationResolverNotFoundException, UserDetailsNotFoundException, NotificationException
event
- Carries information regarding which template to use, which userid initiated it so as to pick up User preferences later from UserPreference Service. From the User Preferences, it finds out the preferred providers to send notificationEventException
UnresolvedNotificationDataExceptionoccurs
TemplateNotFoundException
MultipleTemplateException
NotificationResolverNotFoundException
UserDetailsNotFoundException
NotificationException
UnresolvedNotificationDataException
boolean notify(NotificationEvent event, java.lang.String providerName) throws EventException, UnresolvedNotificationDataException, TemplateNotFoundException, MultipleTemplateException, NotificationResolverNotFoundException, UserDetailsNotFoundException, NotificationException, ProviderNotFoundException, ProviderNotEnabledException, NotificationProviderException
event
- Carries information regarding which template to use, which userid initiated it so as to pick up User preferences later from UserPreference Service. From the User Preferences, it finds out the preferred providers to send notificationproviderName
- - Represents Notification provider name e.g. EmailServiceProvider, UMSEmailServiceProviderEventException
UnresolvedNotificationDataExceptionoccurs
TemplateNotFoundException
MultipleTemplateException
NotificationResolverNotFoundException
UserDetailsNotFoundException
NotificationException
ProviderNotFoundException
ProviderNotEnabledException
NotificationProviderException
UnresolvedNotificationDataException
java.util.List getStaticData(java.lang.String eventType) throws EventException
eventType
- type of the particular foundEventException
java.util.List getAvailableData(java.lang.String eventType, java.util.Map map) throws EventException, UnresolvedNotificationDataException
eventType
- type of the particular eventmap
- map which has the entity name and the corresponding value for which available data is to be fetched.For instance, map.put("Resource", "r1"); will fetch the fields associated with resource r1.EventException
UnresolvedNotificationDataException
java.util.List getEventList()
EventXMLObject getEventDetails(java.lang.String eventType) throws EventException
eventType
- type of the particular eventEventException
java.util.List search(SearchCriteria criteria, java.util.Set retAttrs, java.util.HashMap configParams, java.util.Map resBundleMap) throws InvalidSearchOptionException
criteria
- For specifying searchcriteria use templatename, eventname and locale as parameters only. By default, the results will be sorted based on id column. Calls can be made in the following manner SearchCriteria sc1 = new SearchCriteria("templateName", templateName, SearchCriteria.Operator.EQUAL); SearchCriteria sc2 = new SearchCriteria("eventName", eventName, SearchCriteria.Operator.EQUAL); SearchCriteria sc3 = new SearchCriteria("locale", locale, SearchCriteria.Operator.EQUAL); SearchCriteria sc4 = new SearchCriteria(sc1, sc2, SearchCriteria.Operator.AND); SearchCriteria sc5 = new SearchCriteria(sc4, sc3, SearchCriteria.Operator.AND); long start=1, end=4; List<SearchResult> list = notificationService.searchTemplate(sc5, start, end);retAttrs
- The list of attributes which are to be returned for each user.configParams
- Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.
The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched. These parameters are mandatory.
The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to TEMPLATE_NAME by default.
The SORTORDER search configuration parameter indicates the order of sorting. There are two possible values for this parameter. To sort the result in ascending order use SortOrder.ASCENDING and to sort the result in descending order use SortOrder.DESCENDING. This parameter is optional and is set to SortOrder.ASCENDING by default.
InvalidSearchOptionException
java.util.List search(SearchCriteria criteria, java.util.Set retAttrs, java.util.HashMap configParams) throws InvalidSearchOptionException
criteria
- For specifying searchcriteria use templatename, eventname and locale as parameters only. By default, the results will be sorted based on id column. Calls can be made in the following manner SearchCriteria sc1 = new SearchCriteria("templateName", templateName, SearchCriteria.Operator.EQUAL); SearchCriteria sc2 = new SearchCriteria("eventName", eventName, SearchCriteria.Operator.EQUAL); SearchCriteria sc3 = new SearchCriteria("locale", locale, SearchCriteria.Operator.EQUAL); SearchCriteria sc4 = new SearchCriteria(sc1, sc2, SearchCriteria.Operator.AND); SearchCriteria sc5 = new SearchCriteria(sc4, sc3, SearchCriteria.Operator.AND); long start=1, end=4; List<SearchResult> list = notificationService.searchTemplate(sc5, start, end);retAttrs
- The list of attributes which are to be returned for each user.configParams
- Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.
The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched. These parameters are mandatory.
The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to TEMPLATE_NAME by default.
The SORTORDER search configuration parameter indicates the order of sorting. There are two possible values for this parameter. To sort the result in ascending order use SortOrder.ASCENDING and to sort the result in descending order use SortOrder.DESCENDING. This parameter is optional and is set to SortOrder.ASCENDING by default.
InvalidSearchOptionException
java.util.Set getListedNotificationProviders()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |