@Deprecated public interface UserPrefsProvisioningService extends Serializable
Modifier and Type | Method and Description |
---|---|
void |
addDefaultAddress(String guid,
MediaType mediaType,
DeviceAddress defaultAddress)
Deprecated.
Adds an address into the set of default addresses.
|
void |
addDefaultAddress(String guid,
String profileId,
MediaType mediaType,
DeviceAddress defaultAddress)
Deprecated.
Adds an address into the set of default addresses.
|
void |
addSupportedDeliveryType(DeliveryType type,
String subType)
Deprecated.
Call this to notify UCP for the beginning of a supported delivery type.
|
DeviceAddress |
createDeviceAddress(String guid,
String deviceName,
DeliveryType deliveryType,
String address)
Deprecated.
Creates a user device address in UCP repository.
|
FilterSet |
createFilterSet(String guid,
String profileId,
MediaType mediaType)
Deprecated.
Creates a new user filter set for specified profile and media
type.
|
void |
delete(UserPrefsObject object)
Deprecated.
Deletes the specified UserPrefsObject from persistent store..
|
Set<DeviceAddress> |
findDeviceAddresses(DeliveryType[] deliveryTypes,
String address)
Deprecated.
Finds all user created device addresses that contain the
specified delivery types and address value.
|
Set<DeviceAddress> |
findDeviceAddresses(String address)
Deprecated.
Finds all user created device addresses that contain the
specified address value.
|
List<String> |
getAllProfileIds()
Deprecated.
Gets all application partition profile IDs.
|
DeviceAddress[] |
getDefaultAddresses(String guid,
MediaType mediaType)
Deprecated.
Gets a user's default addresses of specified media type in
default profile.
|
DeviceAddress[] |
getDefaultAddresses(String guid,
String profileId,
MediaType mediaType)
Deprecated.
Gets a user's default addresses for specified profile and media
type.
|
String |
getDefaultProfileId()
Deprecated.
Gets the ID for the default application partition profile.
|
DeviceAddress |
getDeviceAddress(String deviceAddressID)
Deprecated.
Gets a device address object by its unique ID.
|
Map<String,Set<DeviceAddress>> |
getDeviceAddresses()
Deprecated.
Gets all users' device addresses.
|
Set<DeviceAddress> |
getDeviceAddresses(String guid)
Deprecated.
Gets a user's all device addresses.
|
Map<String,Set<DeviceAddress>> |
getDeviceAddresses(String[] guids)
Deprecated.
Gets all device addresses for every GUID in the array.
|
Set<DeviceAddress> |
getDeviceAddresses(String guid,
DeviceAddressType type)
Deprecated.
Gets user device addresses of a particular type.
|
Set<DeviceAddress> |
getDeviceAddresses(String guid,
String profileId)
Deprecated.
Gets a user's device addresses for a specific profile.
|
FilterSet |
getFilterSet(String guid,
String profileId,
MediaType mediaType)
Deprecated.
Gets a user's FilterSet for given profile and media type.
|
Map<String,Set<FilterSet>> |
getFilterSets(String[] guids)
Deprecated.
Gets all filter sets for every GUID in the array.
|
Locale |
getLocale(String guid)
Deprecated.
Gets a user's preferred locale.
|
ReadonlyProfile |
getReadonlyProfile(String profileId)
Deprecated.
Gets a read only partition profile.
|
RuleContext |
getRuleContext(String mediaTypeString,
Locale locale)
Deprecated.
Gets rule context for a media type.
|
Set<String> |
getSupportedChannels()
Deprecated.
Gets delivery channels that are supported by this User Messaging
Services (UMS) server.
|
Set<DeliveryType> |
getSupportedDeliveryTypes()
Deprecated.
Gets DeliveryTypes that are supported by this User Messaging
Services (UMS) server.
|
TimeZone |
getTimeZone(String guid)
Deprecated.
Gets a user's preferred time zone.
|
String |
getUserAttribute(String guid,
String key)
Deprecated.
Gets a user's attribute value by attribute's name.
|
Map<String,String> |
getUserAttributes(String guid)
Deprecated.
Gets a user's all attributes as name-value pairs
|
boolean |
isDefaultAddress(String guid,
MediaType mediaType,
DeviceAddress deviceAdress)
Deprecated.
Returns true if that deviceAddress instance is a default address,
false otherwise.
|
boolean |
isDefaultAddress(String guid,
String profileId,
MediaType mediaType,
DeviceAddress deviceAdress)
Deprecated.
Returns true if that deviceAddress instance is a default address
in the specified profile, false otherwise.
|
void |
removeDefaultAddress(String guid,
MediaType mediaType,
DeviceAddress defaultAddress)
Deprecated.
Removes an address from the set of default addresses.
|
void |
removeDefaultAddress(String guid,
String profileId,
MediaType mediaType,
DeviceAddress defaultAddress)
Deprecated.
Removes an address from the set of default addresses.
|
void |
removeSupportedDeliveryType(DeliveryType type,
String subType)
Deprecated.
Call this to notify UCP for the ending of a supported delivery type.
|
void |
removeUserAttribute(String guid,
String name)
Deprecated.
Removes a user attribute.
|
void |
save(UserPrefsObject object)
Deprecated.
Saves Userprefs objects to persistent store.
|
void |
setDefaultAddresses(String guid,
MediaType mediaType,
DeviceAddress[] defaultAddresses)
Deprecated.
Replaces all existing default address of a media type of the
specified user with the ones in defaultAddresses[].
|
void |
setDefaultAddresses(String guid,
String profileId,
MediaType mediaType,
DeviceAddress[] defaultAddresses)
Deprecated.
Replaces all existing default address of a media type of the
specified user with the ones in defaultAddresses[].
|
void |
setUserAttribute(String guid,
String key,
String value)
Deprecated.
Sets a new attribute value.
|
Locale getLocale(String guid)
guid
- User's GUID.TimeZone getTimeZone(String guid)
guid
- User's GUID.String getUserAttribute(String guid, String key)
guid
- User IDkey
- name of an attribute. Attribute name is case sensitive.void setUserAttribute(String guid, String key, String value) throws UserPrefsException
guid
- User IDkey
- name of an attribute. Attribute name is case sensitive.value
- new value to be set to that attribute. The value is Java
string that can be up to 256 bytes long. If null is
given, that attribute will be deleted.UserPrefsException
void removeUserAttribute(String guid, String name)
guid
- User IDname
- name of attributeMap<String,String> getUserAttributes(String guid)
guid
- User IDMap<String,Set<FilterSet>> getFilterSets(String[] guids)
guids
- a String array of user GUIDs.FilterSet getFilterSet(String guid, String profileId, MediaType mediaType)
guid
- User IDprofileId
- application partitioning profile ID. The default profile
is applied if a null is specified.mediaType
- media type. The default MESSAGING type is applied if a
null is specified.FilterSet createFilterSet(String guid, String profileId, MediaType mediaType) throws UserPrefsException, IllegalArgumentException, ObjectAlreadyExistsException
guid
- globally unique user idprofileId
- application partitioning profile ID. The default profile
is applied if a null is specified.mediaType
- media type. The default MESSAGING type is applied if a
null is specified.UserPrefsException
- if there is a fault or exception on the server sideIllegalArgumentException
- if the userID is nullObjectAlreadyExistsException
- if duplicate object creation is attemptedDeviceAddress createDeviceAddress(String guid, String deviceName, DeliveryType deliveryType, String address) throws UserPrefsException
guid
- The owner of the device address to be created.deviceName
- name of device. Same device name may not be used by
multiple devices of the same user.deliveryType
- delivery type of the device.address
- address of the device.UserPrefsException
DeviceAddress getDeviceAddress(String deviceAddressID)
deviceAddressID
- Unique device address ID.Map<String,Set<DeviceAddress>> getDeviceAddresses()
Map<String,Set<DeviceAddress>> getDeviceAddresses(String[] guids)
guids
- a String array of user GUIDs.Set<DeviceAddress> getDeviceAddresses(String guid)
guid
- User IDSet<DeviceAddress> getDeviceAddresses(String guid, String profileId)
guid
- User IDprofileId
- application partitioning profile ID. The default profile
is applied if a null is specified.Set<DeviceAddress> getDeviceAddresses(String guid, DeviceAddressType type)
guid
- User IDtype
- The type of device addresses to be retrieved.Set<DeviceAddress> findDeviceAddresses(String address)
address
- Address string to be searched for.Set<DeviceAddress> findDeviceAddresses(DeliveryType[] deliveryTypes, String address)
deliveryTypes
- an array of DeliveryType objects.address
- Address string to be searched for.DeviceAddress[] getDefaultAddresses(String guid, MediaType mediaType) throws UserPrefsException
guid
- A user's GUID.mediaType
- MediaType object.UserPrefsException
DeviceAddress[] getDefaultAddresses(String guid, String profileId, MediaType mediaType) throws UserPrefsException
guid
- A user's GUID.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.mediaType
- media type. The default MESSAGING type is applied if a
null is specified.UserPrefsException
void setDefaultAddresses(String guid, MediaType mediaType, DeviceAddress[] defaultAddresses) throws UserPrefsException
guid
- GUID of the user.mediaType
- media type. The default MESSAGING type is applied if a
null is specified.defaultAddresses
- address of the media type of the specified user, or null
to remove default address.UserPrefsException
void setDefaultAddresses(String guid, String profileId, MediaType mediaType, DeviceAddress[] defaultAddresses) throws UserPrefsException
guid
- GUID of the user.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.mediaType
- media type. The default MESSAGING type is applied if a
null is specified.defaultAddresses
- address of the media type of the specified user, or null
to remove default address.UserPrefsException
void addDefaultAddress(String guid, MediaType mediaType, DeviceAddress defaultAddress) throws UserPrefsException
guid
- GUID of the user.mediaType
- media type. The default MESSAGING type is applied if a
null is specified.defaultAddress
- UserPrefsException
void addDefaultAddress(String guid, String profileId, MediaType mediaType, DeviceAddress defaultAddress) throws UserPrefsException
guid
- GUID of the user.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.mediaType
- media type. The default MESSAGING type is applied if a
null is specified.defaultAddress
- UserPrefsException
void removeDefaultAddress(String guid, MediaType mediaType, DeviceAddress defaultAddress) throws UserPrefsException
guid
- GUID of the user.mediaType
- media type. The default MESSAGING type is applied if a
null is specified.defaultAddress
- UserPrefsException
void removeDefaultAddress(String guid, String profileId, MediaType mediaType, DeviceAddress defaultAddress) throws UserPrefsException
guid
- GUID of the user.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.mediaType
- media type. The default MESSAGING type is applied if a
null is specified.defaultAddress
- UserPrefsException
boolean isDefaultAddress(String guid, MediaType mediaType, DeviceAddress deviceAdress)
guid
- GUID of the user.mediaType
- media type. The default MESSAGING type is applied if a
null is specified.deviceAdress
- boolean isDefaultAddress(String guid, String profileId, MediaType mediaType, DeviceAddress deviceAdress)
guid
- GUID of the user.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.mediaType
- media type. The default MESSAGING type is applied if a
null is specified.deviceAdress
- String getDefaultProfileId()
List<String> getAllProfileIds()
ReadonlyProfile getReadonlyProfile(String profileId)
profileId
- the ID of the profile.Set<DeliveryType> getSupportedDeliveryTypes()
void addSupportedDeliveryType(DeliveryType type, String subType)
type
- the new delivery type to be added.subType
- the minor protocol for URI DeliveryType, such as POPUP. Not used for other types.void removeSupportedDeliveryType(DeliveryType type, String subType)
type
- the delivery type to be removed.subType
- the minor protocol for URI DeliveryType, such as POPUP. Not used for other types.Set<String> getSupportedChannels()
RuleContext getRuleContext(String mediaTypeString, Locale locale)
mediaTypeString
- media type. The default MESSAGING type is applied if a
null is specified.locale
- the locale of the rule context.void save(UserPrefsObject object) throws UserPrefsException, IllegalArgumentException
object
- Object(FilterSet, DeviceAddress) to be saved into the
persistent store. This is used to permanantly save the
values of the object after any changes have been made.UserPrefsException
- if there is a fault or exception on the server side * @throws
IllegalArgumentException if the argument is nullIllegalArgumentException
void delete(UserPrefsObject object) throws UserPrefsException, IllegalArgumentException, ObjectNotFoundException
object
- Object(FilterSet, DeviceAddress) to be removed from the
persistent store.UserPrefsException
- thrown if there is a fault or exception on the server
sideIllegalArgumentException
- if the argument is nullObjectNotFoundException
- if the UserPrefsObject does not existCopyright © 2006, 2017 Oracle and/or its affiliates. All rights reserved.