Package org.openiam.srvc.am

Interface ContentProviderWebService

All Known Implementing Classes:

ContentProviderWebServiceImpl

public interface ContentProviderWebService

Method Summary

Modifier and Type	Method	Description
Response	createDefaultURIPatterns(String providerId, URL kibanaURL, URL rabbitmqAdminURL)
Response	deleteAuthLevelAttribute(String id)
Response	deleteAuthLevelGrouping(String id)
Response	deleteContentProvider(String providerId)
Response	deleteProviderPattern(String providerId)
ContentProviderListResponse	findBeans(ContentProviderSearchBean searchBean, int from, int size)	Searches and returns list of ContentProvider objects, using different search criteria
List<URIPattern>	findUriPatterns(URIPatternSearchBean searchBean, int from, int size)
List<URIPatternMetaType>	getAllMetaType()
AuthLevelAttribute	getAuthLevelAttribute(String id)
AuthLevelGrouping	getAuthLevelGrouping(String id)
List<AuthLevelGrouping>	getAuthLevelGroupingList()
List<AuthLevel>	getAuthLevelList()
ContentProvider	getContentProvider(String providerId)	Returns ContentProvider object by its' identity
int	getNumOfContentProviders(ContentProviderSearchBean searchBean)	Returns number of ContentProviders objects which are suitable for passed search criteria
int	getNumOfUriPatterns(URIPatternSearchBean searchBean)
URIPattern	getURIPattern(String patternId)
Response	saveAuthLevelAttribute(AuthLevelAttribute attribute)
Response	saveAuthLevelGrouping(AuthLevelGrouping grouping)
Response	saveContentProvider(ContentProvider provider)	Add or update ContentProvider object.
Response	saveURIPattern(URIPattern pattern)
Response	setupApplication(ContentProvider cp)	This method is called upon initialization of a Tenant / OpenIAM instance
Response	setupApplicationAsynchronously(ContentProvider cp)	This method is called upon initialization of a Tenant / OpenIAM instance After this method returns, you will need to poll by name (call findBeans)
Response	validate(ContentProvider cp)

Method Detail

getAuthLevelAttribute

AuthLevelAttribute getAuthLevelAttribute(String id)

saveAuthLevelAttribute

Response saveAuthLevelAttribute(AuthLevelAttribute attribute)

deleteAuthLevelAttribute

Response deleteAuthLevelAttribute(String id)

saveAuthLevelGrouping

Response saveAuthLevelGrouping(AuthLevelGrouping grouping)

deleteAuthLevelGrouping

Response deleteAuthLevelGrouping(String id)

getAuthLevelGrouping

AuthLevelGrouping getAuthLevelGrouping(String id)

getAuthLevelList

List<AuthLevel> getAuthLevelList()

getAuthLevelGroupingList

List<AuthLevelGrouping> getAuthLevelGroupingList()

setupApplication

Response setupApplication(ContentProvider cp)

This method is called upon initialization of a Tenant / OpenIAM instance

Parameters:

cp -

Returns:

validate

Response validate(ContentProvider cp)

setupApplicationAsynchronously

Response setupApplicationAsynchronously(ContentProvider cp)

This method is called upon initialization of a Tenant / OpenIAM instance After this method returns, you will need to poll by name (call findBeans)

Parameters:

cp -

Returns:

createDefaultURIPatterns

Response createDefaultURIPatterns(String providerId,
                                  URL kibanaURL,
                                  URL rabbitmqAdminURL)

saveContentProvider

Response saveContentProvider(ContentProvider provider)

Add or update ContentProvider object.

Parameters:

provider -

Returns:

getContentProvider

ContentProvider getContentProvider(String providerId)

Returns ContentProvider object by its' identity

Parameters:

providerId -

Returns:

findBeans

ContentProviderListResponse findBeans(ContentProviderSearchBean searchBean,
                                      int from,
                                      int size)

Searches and returns list of ContentProvider objects, using different search criteria

Parameters:

searchBean - - determines search criteria

from - - page index to start

size - - page size

Returns:

getNumOfContentProviders

int getNumOfContentProviders(ContentProviderSearchBean searchBean)

Returns number of ContentProviders objects which are suitable for passed search criteria

Parameters:

searchBean -

Returns:

deleteContentProvider

Response deleteContentProvider(String providerId)

findUriPatterns

List<URIPattern> findUriPatterns(URIPatternSearchBean searchBean,
                                 int from,
                                 int size)

getNumOfUriPatterns

int getNumOfUriPatterns(URIPatternSearchBean searchBean)

getURIPattern

URIPattern getURIPattern(String patternId)

saveURIPattern

Response saveURIPattern(URIPattern pattern)

deleteProviderPattern

Response deleteProviderPattern(String providerId)

getAllMetaType

List<URIPatternMetaType> getAllMetaType()