public class KernelServicesWs extends Object
Modifier and Type | Class and Description |
---|---|
static class |
KernelServicesWs.ErrorCodes
Enum with all possible error codes listed.
|
static class |
KernelServicesWs.KernelServicesWSFault
Own exception class for the KernelServicesWs soap interface.
|
Constructor and Description |
---|
KernelServicesWs() |
Modifier and Type | Method and Description |
---|---|
List<com.kobil.ssms.kernel.presentation.b2b.SsmsNode> |
getNodes()
Retrieve information about all SSMS nodes.
|
List<KrnProperty> |
getProperties(PropertyParam propertyParam,
com.kobil.ssms.kernel.presentation.b2b.RangeInput rangeInput,
com.kobil.ssms.kernel.logic.pagination.OrderInput orderInput,
Holder<com.kobil.ssms.kernel.presentation.b2b.Pagination> pagination)
Gets a list of
KrnProperty for a user or group. |
KrnProperty |
getProperty(PropertyParam propertyParam)
Gets a
KrnProperty for a user's property or a group's property. |
void |
removeProperty(KrnProperty property)
Removes a property of a user or a group.
|
SearchResult |
searchUserPropertyStringValues(String key,
String value)
Search for users, which own a property with the given key and string
value.
|
SearchResult |
searchUserPropertyValues(String key,
byte[] value)
Search for users, which own a property with the given key and binary
value.
|
void |
setProperty(KrnProperty property)
Sets a property to a user or to a group.
|
public List<com.kobil.ssms.kernel.presentation.b2b.SsmsNode> getNodes() throws KernelServicesWs.KernelServicesWSFault
SsmsNode
objects.KernelServicesWs.KernelServicesWSFault
- KernelServicesWs.ErrorCodes.GENERAL_ERROR
if an internal error occurredpublic KrnProperty getProperty(PropertyParam propertyParam) throws KernelServicesWs.KernelServicesWSFault
KrnProperty
for a user's property or a group's property.propertyParam
- The PropertyParam
parameters which define the property
to be searched. The fields PropertyParam.owner,
PropertyParam.id, and PropertyParam.key are required. Other
fields of PropertyParam will be ignored by this method.KrnProperty
if a property was found.KernelServicesWSFault
- KernelServicesWs.ErrorCodes.PROPERTY_INVALID
propertyParam is null. KernelServicesWs.ErrorCodes.KEY_INVALID
the passed key is null, empty or out
of range.KernelServicesWs.ErrorCodes.UNKNOWN_OWNER_TYPE
the owner type is null.KernelServicesWs.ErrorCodes.INVALID_CHARACTERS
the property key contains
invalid characters. Only printable ASCII characters (code 32
to 126) are allowed. KernelServicesWs.ErrorCodes.PARAMETER_INVALID
the id is null, empty or does not match owner type. KernelServicesWs.ErrorCodes.GROUP_DOES_NOT_EXIST
the group, for which property
is requested, does not exist. KernelServicesWs.ErrorCodes.USER_DOES_NOT_EXIST
the user, for whom property is
requested, does not exist. KernelServicesWs.ErrorCodes.REQUESTED_PROPERTY_NOT_FOUND
the requested
property was not found. KernelServicesWs.ErrorCodes.NO_ACCESS_TO_PROPERTY
portal has no access to this property.KernelServicesWs.ErrorCodes.GENERAL_ERROR
internal error occurred. KernelServicesWs.KernelServicesWSFault
public List<KrnProperty> getProperties(PropertyParam propertyParam, com.kobil.ssms.kernel.presentation.b2b.RangeInput rangeInput, com.kobil.ssms.kernel.logic.pagination.OrderInput orderInput, Holder<com.kobil.ssms.kernel.presentation.b2b.Pagination> pagination) throws KernelServicesWs.KernelServicesWSFault
KrnProperty
for a user or group. The list contains
all properties, which exist for this user/group. propertyParam
- The PropertyParam
parameters which define the property
to be searched. Note: propertyParam.key is optionalrangeInput
- - RangeInput object with information about range with "from" and "limit" values orderInput
- - OrderInput object with information about sorting field name and direction pagination
- - Holder for Pagination with information about range and order.
range is an object with "from", "limit" and "moreExist" values KrnProperty
. If no property was found, the list
is empty.KernelServicesWs.KernelServicesWSFault
- KernelServicesWs.ErrorCodes.PARAMETER_INVALID
propertyParam is null. Or the id is null, empty or does not match owner type. KernelServicesWs.ErrorCodes.UNKNOWN_OWNER_TYPE
the owner type is null.KernelServicesWs.ErrorCodes.GROUP_DOES_NOT_EXIST
the group, for which property
is requested, does not exist. KernelServicesWs.ErrorCodes.USER_DOES_NOT_EXIST
the user, for whom property is
requested, does not exist. KernelServicesWs.ErrorCodes.KEY_INVALID
the passed key is out of range.KernelServicesWs.ErrorCodes.INVALID_CHARACTERS
the passed key contains invalid
characters. Only printable ASCII characters (code 32 to 126)
are allowed. KernelServicesWs.ErrorCodes.REQUESTED_PROPERTY_NOT_FOUND
If PropertyParam.key is specified, and according property does not exist.
KernelServicesWs.ErrorCodes.GENERAL_ERROR
internal error occurred. public void setProperty(KrnProperty property) throws KernelServicesWs.KernelServicesWSFault
property
- The KrnProperty
parameters which define the property.KernelServicesWSFault
- KernelServicesWs.ErrorCodes.PROPERTY_INVALID
propertyParam is null. KernelServicesWs.ErrorCodes.KEY_INVALID
the passed key is null, empty or out
of range.KernelServicesWs.ErrorCodes.UNKNOWN_OWNER_TYPE
the owner type is null. KernelServicesWs.ErrorCodes.INVALID_CHARACTERS
the property key contains
invalid characters. Only printable ASCII characters (code 32
to 126) are allowed. KernelServicesWs.ErrorCodes.FLAG_INVALID
the flag is out of range.KernelServicesWs.ErrorCodes.TYPE_INVALID
the type is out of range.KernelServicesWs.ErrorCodes.BINARY_VALUE_INVALID
the binary value is null, out
of range (for type INTEGER) or cannot be parsed (for type
Date) KernelServicesWs.ErrorCodes.PARAMETER_INVALID
invalid flags combination. Or the id is null, empty or does not match owner type. KernelServicesWs.ErrorCodes.GROUP_DOES_NOT_EXIST
the group, for which property
is requested, does not exist. KernelServicesWs.ErrorCodes.USER_DOES_NOT_EXIST
the user, for whom property is
requested, does not exist. KernelServicesWs.ErrorCodes.REQUESTED_PROPERTY_NOT_FOUND
the requested
property was not found. KernelServicesWs.ErrorCodes.NO_ACCESS_TO_PROPERTY
portal has no access to this
property (only in case of changing an existing property)KernelServicesWs.ErrorCodes.PROPERTY_READ_ONLY
Property is READ_ONLY and
cannot be modified (only in case of changing an existing
property)KernelServicesWs.ErrorCodes.GENERAL_ERROR
internal error occurred. KernelServicesWs.KernelServicesWSFault
public void removeProperty(KrnProperty property) throws KernelServicesWs.KernelServicesWSFault
property
- the fields KrnProperty.owner, KrnProperty.id and
KrnProperty.key are required. Other fields of KrnProperty will
be ignored by this method.KernelServicesWSFault
- KernelServicesWs.ErrorCodes.PROPERTY_INVALID
krnProperty is null. KernelServicesWs.ErrorCodes.KEY_INVALID
the passed key is null, empty or out
of range.KernelServicesWs.ErrorCodes.INVALID_CHARACTERS
the property key contains
invalid characters. Only printable ASCII characters (code 32
to 126) are allowed. KernelServicesWs.ErrorCodes.UNKNOWN_OWNER_TYPE
the owner type is null. KernelServicesWs.ErrorCodes.PARAMETER_INVALID
the id is null, empty or does not match owner type. KernelServicesWs.ErrorCodes.GROUP_DOES_NOT_EXIST
the group, for which property
is requested, does not exist. KernelServicesWs.ErrorCodes.USER_DOES_NOT_EXIST
the user, for whom property is
requested, does not exist. KernelServicesWs.ErrorCodes.REQUESTED_PROPERTY_NOT_FOUND
the requested
property was not found. Property
is READ_ONLY and
cannot be modifiedKernelServicesWs.ErrorCodes.NO_ACCESS_TO_PROPERTY
portal has no access to this
property.KernelServicesWs.ErrorCodes.GENERAL_ERROR
internal error occurred. KernelServicesWs.KernelServicesWSFault
public SearchResult searchUserPropertyValues(String key, byte[] value) throws KernelServicesWs.KernelServicesWSFault
key
- name of the propertyvalue
- binary value of the propertySearchResult
container class which contains a result code
and a list of usersKernelServicesWSFault
- KernelServicesWs.ErrorCodes.KEY_INVALID
if the key is null, empty or out of
range.KernelServicesWs.ErrorCodes.INVALID_CHARACTERS
the property key contains
invalid characters. Only printable ASCII characters (code 32
to 126) are allowed. KernelServicesWs.ErrorCodes.BINARY_VALUE_INVALID
if the binary value is null
or empty.KernelServicesWs.ErrorCodes.GENERAL_ERROR
internal error occurred. KernelServicesWs.KernelServicesWSFault
public SearchResult searchUserPropertyStringValues(String key, String value) throws KernelServicesWs.KernelServicesWSFault
key
- name of the propertyvalue
- string value of the propertySearchResult
container class which contains a result code
and a list of usersKernelServicesWs.KernelServicesWSFault
- KernelServicesWs.ErrorCodes.KEY_INVALID
if the key is null, empty or out of
range.KernelServicesWs.ErrorCodes.INVALID_CHARACTERS
the property key contains
invalid characters. Only printable ASCII characters (code 32
to 126) are allowed. KernelServicesWs.ErrorCodes.BINARY_VALUE_INVALID
if the value is null
or empty.KernelServicesWs.ErrorCodes.GENERAL_ERROR
internal error occurred. Copyright © 2022 KOBIL Systems GmbH. All rights reserved.