Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6)

E21908-03

oracle.ecsf
Interface SecurityService


public interface SecurityService

SecurityService is used to apply security authentication and authorization checks.


Method Summary
 java.lang.String authenticate(SearchContext searchContext, java.lang.String userId, char[] password, java.lang.String userIdFormat)
          Authenticate user.
 java.lang.String authorize(SearchContext searchContext, java.lang.String userId, java.lang.String service, java.lang.String userIdFormat)
          Authorize the current user.
 java.lang.String[] getSecurityValues(SearchContext searchContext, java.lang.String userId, java.lang.String attrName, java.lang.String objectId, java.lang.String userIdFormat)
          Gets security values/keys of a secure attribute in a searchable object.
 java.lang.String isUserValid(SearchContext searchContext, java.lang.String userId, java.lang.String userIdFormat)
          Check if user is valid.
 java.lang.String[] listSupportedFormats()
          Return support user format list.
 

Method Detail

listSupportedFormats

java.lang.String[] listSupportedFormats()
Return support user format list. return String[]


authenticate

java.lang.String authenticate(SearchContext searchContext,
                              java.lang.String userId,
                              char[] password,
                              java.lang.String userIdFormat)
Authenticate user.

Parameters:
searchContext -
userId -
password -
userIdFormat -
Returns:
userId if userId is successfully authenticated. null otherwise.

authorize

java.lang.String authorize(SearchContext searchContext,
                           java.lang.String userId,
                           java.lang.String service,
                           java.lang.String userIdFormat)
Authorize the current user.

Parameters:
searchContext -
userId -
service -
userIdFormat -
Returns:
userId if userId is successfully authorized. null otherwise.

isUserValid

java.lang.String isUserValid(SearchContext searchContext,
                             java.lang.String userId,
                             java.lang.String userIdFormat)
Check if user is valid.

Parameters:
searchContext -
userId -
userIdFormat -
Returns:
userId if userId is valid, null otherwise.

getSecurityValues

java.lang.String[] getSecurityValues(SearchContext searchContext,
                                     java.lang.String userId,
                                     java.lang.String attrName,
                                     java.lang.String objectId,
                                     java.lang.String userIdFormat)
Gets security values/keys of a secure attribute in a searchable object.

Parameters:
searchContext -
userId -
attrName - attribute name
objectId - searchable object id
userIdFormat - of userId
Returns:
String[] of keys

Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6)

E21908-03

Copyright © 2012 Oracle. All rights reserved.