public interface ServiceData
Modifier and Type | Method and Description |
---|---|
String |
getGlobalServiceAttribute(String attrName)
Deprecated.
Replaced by
getServiceAttribute(String) |
List |
getGlobalServiceAttributeList()
Deprecated.
Replaced by
getServiceAttributeList() |
String |
getGlobalServiceEncryptedAttribute(String attrName)
Deprecated.
Replaced by
getServiceEncryptedAttribute(String) |
String |
getServiceAttribute(String attrName)
Returns the value for a service attribute that's not uniquely
administered for a particular user, but global to the service.
|
String |
getServiceAttribute(String userAddress,
AddressType addressType,
String attrName)
Returns the value for a service attribute for a user of the specified address type.
|
String |
getServiceAttribute(String userAddress,
String attrName)
Returns the value for a service attribute.
|
List |
getServiceAttributeList()
Returns a list of available Service Attributes for a given service.
|
String |
getServiceEncryptedAttribute(String attrName)
Returns the value for a service encrypted attribute that's not uniquely
administered for a particular user, but global to the service.
|
String |
getSupplierId()
Returns the Supplier Id of the service as specified in the properties.xml
file of the service.The service name should be specified when ServiceData
instance is acquired using CollaborationDataFactory.getServiceData().
|
boolean |
isSignedService()
Indicates whether the service has been signed by Avaya or not.The service
name and service version should be specified when ServiceData instance is
acquired using CollaborationDataFactory.getServiceData().
|
String getServiceAttribute(String userAddress, String attrName) throws NoUserFoundException, NoAttributeFoundException, ServiceNotFoundException, NoServiceProfileFoundException
AddressType.AVAYA_SIP
by default.
To specify a different address type use getServiceAttribute(String, AddressType, String)
.userAddress
- user address in the form of "user@domain"attrName
- attribute name as specified in the attribute element, name
attribute in the properties.xml file of the service archiveNoServiceProfileFoundException
- when the user is not configured with a service profile in the
UI.ServiceNotFoundException
- when the service was not deployed/installed in CE.NoUserFoundException
- when the user was not configured in CE.NoAttributeFoundException
String getServiceAttribute(String userAddress, AddressType addressType, String attrName) throws NoUserFoundException, NoAttributeFoundException, ServiceNotFoundException, NoServiceProfileFoundException, InvalidAddressTypeException
userAddress
- user address in the form of "user@domain"addressType
- type of the user addressattrName
- attribute name as specified in the attribute element, name
attribute in the properties.xml file of the service archiveNoServiceProfileFoundException
- when the user is not configured with a service profile in the
UI.ServiceNotFoundException
- when the service was not deployed/installed in CE.NoUserFoundException
- when the user was not configured in CE.NoAttributeFoundException
- when the specified attribute is not found for the serviceInvalidAddressTypeException
- when the address type is null.@Deprecated String getGlobalServiceAttribute(String attrName) throws NoAttributeFoundException, ServiceNotFoundException
getServiceAttribute(String)
String getServiceAttribute(String attrName) throws NoAttributeFoundException, ServiceNotFoundException
UnsupportedOperationException
runtime exception.
Service Encrypted attributes should be retrieved via appropriate method.attrName
- attribute name as specified in the attribute element, name
attribute in the properties.xml file of the service archive.NoAttributeFoundException
- when the attribute does not exist in the properties.xml file.ServiceNotFoundException
- when the service name does not exist, the service name as
specified in the properties.xml file.List getServiceAttributeList() throws ServiceNotFoundException
ServiceNotFoundException
- when the service was not deployed in CE.@Deprecated List getGlobalServiceAttributeList() throws ServiceNotFoundException
getServiceAttributeList()
ServiceNotFoundException
@Deprecated String getGlobalServiceEncryptedAttribute(String attrName) throws NoAttributeFoundException, ServiceNotFoundException
getServiceEncryptedAttribute(String)
String getServiceEncryptedAttribute(String attrName) throws NoAttributeFoundException, ServiceNotFoundException
attrName
- attribute name as specified in the attribute element, name
attribute in the properties.xml file of the service archive.NoAttributeFoundException
- when the attribute does not exist in the properties.xml file.ServiceNotFoundException
- when the service name does not exist, the service name as
specified in the properties.xml file.boolean isSignedService() throws ServiceNotFoundException
ServiceNotFoundException
- when the service name or service version specified at the
time of acquiring ServiceData instance does not exist.String getSupplierId() throws ServiceNotFoundException, NoAttributeFoundException
ServiceNotFoundException
- when the service name specified at the time of acquiring
ServiceData instance does not exist.NoAttributeFoundException
- when a supplier ID for this service is not defined in the
properties.xml file.Copyright © 2016 Avaya. All Rights Reserved.