public class CarbonEntitlementDataFinder extends Object implements EntitlementDataFinderModule
Constructor and Description |
---|
CarbonEntitlementDataFinder() |
Modifier and Type | Method and Description |
---|---|
EntitlementTreeNodeDTO |
getEntitlementData(String category,
String regex,
int limit)
Finds entitlement data values for given category type
|
EntitlementTreeNodeDTO |
getEntitlementDataByLevel(String category,
int level)
Finds entitlement data values for given category and for given hierarchical level
|
String |
getModuleName()
Gets name of this module
|
Set<String> |
getRelatedApplications()
Returns application names that are related with entitlement data that is retrieved by this
module
|
Set<String> |
getSupportedCategories()
Returns categories that are supported with entitlement data that is retrieved by this
module
|
int |
getSupportedHierarchicalLevels()
Returns supported hierarchical levels of that data must be retrieved.
|
void |
init(Properties properties)
Initializes data retriever module
|
boolean |
isAllApplicationRelated()
Defines whether entitlement data that is retrieved by this module,
is related with all applications
|
boolean |
isFullPathSupported()
Defines whether node
EntitlementTreeNodeDTO is defined by child node name
or by full path name with parent node names |
boolean |
isHierarchicalTree()
Defines whether tree nodes of
EntitlementTreeNodeDTO elements are shown
in UI by as a tree or flat structure |
boolean |
isSearchSupported()
Defines whether we can search the tree nodes of
EntitlementTreeNodeDTO elements
using regexp expressions |
public void init(Properties properties) throws Exception
EntitlementDataFinderModule
init
in interface EntitlementDataFinderModule
properties
- properties, that need to initialize the module. These properties can be
defined in entitlement.properties fileException
- throws when initialization is failedpublic String getModuleName()
EntitlementDataFinderModule
getModuleName
in interface EntitlementDataFinderModule
public Set<String> getRelatedApplications()
EntitlementDataFinderModule
getRelatedApplications
in interface EntitlementDataFinderModule
public Set<String> getSupportedCategories()
EntitlementDataFinderModule
getSupportedCategories
in interface EntitlementDataFinderModule
public EntitlementTreeNodeDTO getEntitlementData(String category, String regex, int limit) throws Exception
EntitlementDataFinderModule
getEntitlementData
in interface EntitlementDataFinderModule
category
- category of the entitlement data.regex
- regex values for filter out the return datalimit
- limit for filtered dataEntitlementTreeNodeDTO
Exception
- throws, if failspublic EntitlementTreeNodeDTO getEntitlementDataByLevel(String category, int level) throws Exception
EntitlementDataFinderModule
getEntitlementDataByLevel
in interface EntitlementDataFinderModule
category
- category of the entitlement data.level
- hierarchical level that data must be retrieved. If root level, value must be 1EntitlementTreeNodeDTO
Exception
- throws, if failspublic int getSupportedHierarchicalLevels()
EntitlementDataFinderModule
getSupportedHierarchicalLevels
in interface EntitlementDataFinderModule
public boolean isFullPathSupported()
EntitlementDataFinderModule
EntitlementTreeNodeDTO
is defined by child node name
or by full path name with parent node namesisFullPathSupported
in interface EntitlementDataFinderModule
public boolean isHierarchicalTree()
EntitlementDataFinderModule
EntitlementTreeNodeDTO
elements are shown
in UI by as a tree or flat structureisHierarchicalTree
in interface EntitlementDataFinderModule
public boolean isAllApplicationRelated()
EntitlementDataFinderModule
isAllApplicationRelated
in interface EntitlementDataFinderModule
public boolean isSearchSupported()
EntitlementDataFinderModule
EntitlementTreeNodeDTO
elements
using regexp expressionsisSearchSupported
in interface EntitlementDataFinderModule
Copyright © 2016 WSO2. All rights reserved.