com.ibm.websphere.wim
Interface ConfigService

All Superinterfaces:
ConfigConstants
All Known Subinterfaces:
LocalService, Service, WIMService, WIMServiceLocal
All Known Implementing Classes:
LocalServiceProvider, ServiceProvider

public interface ConfigService
extends ConfigConstants

The configuation service interface.


Field Summary
static java.lang.String ACTION_CREATE
           
static java.lang.String ACTION_DELETE
           
static java.lang.String ACTION_READ
           
static java.lang.String ACTION_UPDATE
           
static java.lang.String SYS_PROP_WIM_HOME
          The name of the system property for defining the virtual member manager home path.
static java.lang.String SYS_PROP_WIM_SCHEMA_HOME
          The name of the system property for defining the virtual member manager schema home path.
static java.lang.String WIM_CONFIG_SCHEMA_PACKAGE_NAME
          The default name of the virtual member manager config model package.
static java.lang.String WIM_CONFIG_XML_FILE_DEFAULT
          The default name of the virtual member manager configuration file.
static java.lang.String WIM_CUSTOM_POLICY_CONFIG
          The name of the virtual member manager Custom Policy config file.
static java.lang.String WIM_DEFAULT_POLICY_CONFIG
          The name of the virtual member manager Default Policy config file.
static java.lang.String WIM_HOME_CONFIG
          The name of sub directory under virtual member manager home path which contains virtual member manager config files (wimconfig.xml and wimconfig.xsd)
static java.lang.String WIM_HOME_MODEL
          The name of sub directory under virtual member manager home path which contains virtual member manager model files (wimdomain.xsd, wimdatagraph.xsd)
static java.lang.String WIM_HOME_POLICY
           
static java.lang.String WIM_MODEL_PACKAGE_DEFAULT
          The default name of the virtual member manager data model package.
static java.lang.String WIM_MODEL_XSD_FILE_DEFAULT
          The default name of the virtual member manager model extension XSD file.
static java.lang.String WIM_POLICY_CONFIG_SCHEMA_PACKAGE_NAME
          The default name of the virtual member manager Policy config model package.
 
Fields inherited from interface com.ibm.websphere.wim.ConfigConstants
ALL_AUTHENTICATED, BASE_SUBDIR, CONFIG_ADMIN_ROLE, CONFIG_AUTHENTICATION_TYPE_NONE, CONFIG_AUTHENTICATION_TYPE_SIMPLE, CONFIG_AUTHENTICATION_TYPE_STRONG, CONFIG_AUTHENTICATION_TYPES, CONFIG_AUTHORIZATION, CONFIG_CACHE_DIST_NONE, CONFIG_CACHE_DIST_POLICIES, CONFIG_CACHE_DIST_PUSH, CONFIG_CACHE_DIST_PUSH_PULL, CONFIG_CHANGELOG_SUPPORT_TYPES, CONFIG_DB_DB2, CONFIG_DB_DB2ISERIES, CONFIG_DB_DB2ZOS, CONFIG_DB_DERBY, CONFIG_DB_INFORMIX, CONFIG_DB_ORACLE, CONFIG_DB_SQLSERVER, CONFIG_DB_SUPPORTED_TYPES, CONFIG_DO_ATTRIBUTE_CONFIGUARTION, CONFIG_DO_ATTRIBUTES, CONFIG_DO_ATTRIBUTES_CACHE, CONFIG_DO_BASE_ENTRIES, CONFIG_DO_CACHE_CONFIGURATION, CONFIG_DO_CONFIG_PROVIDER, CONFIG_DO_CONNECTIONS, CONFIG_DO_CONTEXT_POOL, CONFIG_DO_CUSTOM_PROPERTIES, CONFIG_DO_DATABASE_REPOSITORY_TYPE, CONFIG_DO_DEFAULT_PARENTS, CONFIG_DO_DYNAMIC_MEMBER_ATTRIBUTES, CONFIG_DO_DYNAMIC_MODEL, CONFIG_DO_ENTITY_TYPES_NOT_ALLOW_CREATE, CONFIG_DO_ENTITY_TYPES_NOT_ALLOW_DELETE, CONFIG_DO_ENTITY_TYPES_NOT_ALLOW_READ, CONFIG_DO_ENTITY_TYPES_NOT_ALLOW_UPDATE, CONFIG_DO_ENTRY_MAPPING_REPOSITORY, CONFIG_DO_EXTERNAL_ID_ATTRIBUTES, CONFIG_DO_FILE_REPOSITORY_TYPE, CONFIG_DO_GROUP_CONFIGURATION, CONFIG_DO_GROUP_DISPLAY_NAME_MAPPING, CONFIG_DO_GROUP_SECURITY_NAME_MAPPING, CONFIG_DO_LDAP_ENTITY_TYPES, CONFIG_DO_LDAP_REPOSITORY_TYPE, CONFIG_DO_LDAP_SERVER_CONFIGURATION, CONFIG_DO_LDAP_SERVERS, CONFIG_DO_MEMBER_ATTRIBUTES, CONFIG_DO_MEMBERSHIP_ATTRIBUTES, CONFIG_DO_OBJECTCLASSES, CONFIG_DO_OBJECTCLASSES_FOR_CREATE, CONFIG_DO_PARTICIPATING_BASE_ENTRIES, CONFIG_DO_POLICY, CONFIG_DO_PROPERTIES_NOT_SUPPORTED, CONFIG_DO_PROPERTY_EXTENSION_REPOSITORY, CONFIG_DO_RDN_ATTRIBUTES, CONFIG_DO_RDN_PROPERTIES, CONFIG_DO_REALM_CONFIG, CONFIG_DO_REALMS, CONFIG_DO_REPOSITORIES, CONFIG_DO_REPOSITORIES_FOR_GROUPS, CONFIG_DO_SEARCH_RESULTS_CACHE, CONFIG_DO_STATIC_MODEL, CONFIG_DO_SUPPORTED_ENTITY_TYPES, CONFIG_DO_UNIQUE_GROUP_ID_MAPPING, CONFIG_DO_UNIQUE_USER_ID_MAPPING, CONFIG_DO_USER_DISPLAY_NAME_MAPPING, CONFIG_DO_USER_REGISTRY, CONFIG_DO_USER_SECURITY_NAME_MAPPING, CONFIG_JACC_POLICY_CLASS, CONFIG_JACC_POLICY_FACTORY_CLASS, CONFIG_JACC_PRINCIPALROLE_FILENAME, CONFIG_JACC_PRINCIPALROLE_POLICY_ID, CONFIG_JACC_ROLEMAPPING_CLASS, CONFIG_JACC_ROLEMAPPING_FACTORY_CLASS, CONFIG_JACC_ROLEPERMISSION_FILENAME, CONFIG_JACC_ROLEPERMISSION_POLICY_ID, CONFIG_LDAP_AD, CONFIG_LDAP_AD2000, CONFIG_LDAP_AD2003, CONFIG_LDAP_ADAM, CONFIG_LDAP_CUSTOM, CONFIG_LDAP_DOMINO, CONFIG_LDAP_DOMINO5, CONFIG_LDAP_DOMINO6, CONFIG_LDAP_DOMINO65, CONFIG_LDAP_IDS, CONFIG_LDAP_IDS4, CONFIG_LDAP_IDS51, CONFIG_LDAP_IDS52, CONFIG_LDAP_IDS6, CONFIG_LDAP_NDS, CONFIG_LDAP_SECUREWAY, CONFIG_LDAP_SUNONE, CONFIG_LDAP_SUPPORTED_TYPES, CONFIG_LDAP_ZOSDS, CONFIG_MDALGO_SHA1, CONFIG_MDALGO_SHA256, CONFIG_MDALGO_SHA384, CONFIG_MDALGO_SHA512, CONFIG_PROFILE_REPOSITORY_TYPE, CONFIG_PROP_ACCESS_ENABLED, CONFIG_PROP_ADMIN_ID, CONFIG_PROP_ADMIN_PASSWORD, CONFIG_PROP_ALLOW_OPERATION_IF_REPOS_DOWN, CONFIG_PROP_ALLOW_WRITE_TO_SECONDARY_SERVERS, CONFIG_PROP_ATTRIBUTE_RANGE_STEP, CONFIG_PROP_ATTRIBUTE_SIZE_LIMIT, CONFIG_PROP_AUTHENTICATION, CONFIG_PROP_BASE_DIRECTORY, CONFIG_PROP_BIND_DN, CONFIG_PROP_BIND_PASSWORD, CONFIG_PROP_CACHE_DIST_POLICY, CONFIG_PROP_CACHE_SIZE, CONFIG_PROP_CACHE_TIME_OUT, CONFIG_PROP_CACHES_DISK_OFF_LOAD, CONFIG_PROP_CASE_SENSITIVE, CONFIG_PROP_CERTIFICATE_FILTER, CONFIG_PROP_CERTIFICATE_MAP_MODE, CONFIG_PROP_CERTIFICATE_MAP_MODE_VALUES, CONFIG_PROP_CONNECT_TIMEOUT, CONFIG_PROP_CONNECTION_POOL, CONFIG_PROP_DATABASE_TYPE, CONFIG_PROP_DATASOURCE_NAME, CONFIG_PROP_DB_ADMIN_ID, CONFIG_PROP_DB_ADMIN_PASSWORD, CONFIG_PROP_DB_SCHEMA, CONFIG_PROP_DB_URL, CONFIG_PROP_DEFAULT_ATTRIBUTE, CONFIG_PROP_DEFAULT_PARENT, CONFIG_PROP_DEFAULT_REALM, CONFIG_PROP_DEFAULT_VALUE, CONFIG_PROP_DELIMITER, CONFIG_PROP_DEREFALIASES, CONFIG_PROP_DUMMY_MEMBER, CONFIG_PROP_ENABLED, CONFIG_PROP_ENCRYPTION_KEY, CONFIG_PROP_ENTITY_RETRIEVAL_LIMIT, CONFIG_PROP_ENTITY_TYPE_NAME, CONFIG_PROP_ENTITY_TYPES, CONFIG_PROP_ENTITY_TYPES_LIST, CONFIG_PROP_ENVIRONMENT_PROPERTIES, CONFIG_PROP_FILE_NAME, CONFIG_PROP_GENERATE_EXTID, CONFIG_PROP_GROUP_NAME, CONFIG_PROP_HOST, CONFIG_PROP_ID, CONFIG_PROP_INIT_POOL_SIZE, CONFIG_PROP_IS_EXTID_UNIQUE, CONFIG_PROP_JDBC_DRIVER_CLASS, CONFIG_PROP_LDAP_SERVER_TYPE, CONFIG_PROP_LOGIN_PROPERTIES, CONFIG_PROP_MAX_PAGING_RESULTS, CONFIG_PROP_MAX_POOL_SIZE, CONFIG_PROP_MAX_SEARCH_RESULTS, CONFIG_PROP_MAX_TOTAL_PAGING_RESULTS, CONFIG_PROP_MESSAGEDIGEST_ALGORITHM, CONFIG_PROP_NAME, CONFIG_PROP_NAME_IN_REPOSITORY, CONFIG_PROP_OBJECT_CLASS, CONFIG_PROP_OBJECTCLASS, CONFIG_PROP_PACKAGE_NAME, CONFIG_PROP_PAGED_CACHE_TIME_OUT, CONFIG_PROP_PAGING_CACHES_DISK_OFF_LOAD, CONFIG_PROP_PAGING_ENTITY_OBJECT, CONFIG_PROP_PARENTS_UNIQUE_NAME, CONFIG_PROP_POOL_TIME_OUT, CONFIG_PROP_POOL_WAIT_TIME, CONFIG_PROP_PORT, CONFIG_PROP_PREF_POOL_SIZE, CONFIG_PROP_PRIMARY_SERVER_QUERY_TIME_INTERVAL, CONFIG_PROP_PROPERTY_FOR_INPUT, CONFIG_PROP_PROPERTY_FOR_OUTPUT, CONFIG_PROP_PROPERTY_NAME, CONFIG_PROP_READ_ONLY, CONFIG_PROP_REALM_NAME, CONFIG_PROP_REALM_NODE, CONFIG_PROP_REFERAL, CONFIG_PROP_REPOS_ADAPTER_CLASS_NAME, CONFIG_PROP_REPOS_NAME, CONFIG_PROP_RETURN_TO_PRIMARY_SERVER, CONFIG_PROP_ROLE_NAME, CONFIG_PROP_SALT_LENGTH, CONFIG_PROP_SCOPE, CONFIG_PROP_SEARCH_COUNT_LIMIT, CONFIG_PROP_SEARCH_PAGE_SIZE, CONFIG_PROP_SEARCH_RESULTS_SIZE_LIMIT, CONFIG_PROP_SEARCH_TIME_LIMIT, CONFIG_PROP_SEARCH_TIME_OUT, CONFIG_PROP_SEARCHBASES, CONFIG_PROP_SEARCHFILTER, CONFIG_PROP_SECURITY_USE, CONFIG_PROP_SERVER_EXTERNAL_NAME, CONFIG_PROP_SERVER_TTL_ATTRIBUTE, CONFIG_PROP_SSL_CONFIGURATION, CONFIG_PROP_SSL_DEBUG, CONFIG_PROP_SSL_ENABLED, CONFIG_PROP_SSL_KEY_STORE, CONFIG_PROP_SSL_KEY_STORE_PASSOWRD, CONFIG_PROP_SSL_KEY_STORE_TYPE, CONFIG_PROP_SSL_TRUST_STORE, CONFIG_PROP_SSL_TRUST_STORE_PASSWORD, CONFIG_PROP_SSL_TRUST_STORE_TYPE, CONFIG_PROP_SUPPORT_ASYNC_MODE, CONFIG_PROP_SUPPORT_CHANGE_LOG, CONFIG_PROP_SUPPORT_EXTERNAL_NAME, CONFIG_PROP_SUPPORT_PAGING, CONFIG_PROP_SUPPORT_SORTING, CONFIG_PROP_SUPPORT_TRANSACTIONS, CONFIG_PROP_SYNTAX, CONFIG_PROP_TOPIC_SUBSCRIBER_NAME, CONFIG_PROP_TRANSLATE_RDN, CONFIG_PROP_UPDATE_GROUP_MEMBERSHIP, CONFIG_PROP_USE_GLOBAL_SCHEMA, CONFIG_PROP_USER_NAME, CONFIG_PROP_VALUE, CONFIG_PROP_WIM_GENERATE, CONFIG_PROP_XSD_FILE_NAME, CONFIG_PROPERTY_EXTENSION_REPOSITORY_TYPE, CONFIG_READER_ROLE, CONFIG_REALM_CONFIG_TYPE, CONFIG_REALM_SECURITY_USE_VALUES, CONFIG_REALM_TYPE, CONFIG_ROOT, CONFIG_SCOPE_ALL, CONFIG_SCOPE_DIRECT, CONFIG_SCOPE_NESTED, CONFIG_SCOPES, CONFIG_SUPPORT_CHANGE_LOG_NATIVE, CONFIG_SUPPORT_CHANGE_LOG_NONE, CONFIG_SUPPORTED_MDALGORITHMS, CONFIG_UR_ATTR_NAME, CONFIG_URATTR_GROUP_DISPLAY_NAME, CONFIG_URATTR_GROUP_SECURITY_NAME, CONFIG_URATTR_UNIQUE_GROUP_ID, CONFIG_URATTR_UNIQUE_USER_ID, CONFIG_URATTR_USER_DISPLAY_NAME, CONFIG_URATTR_USER_SECURITY_NAME, CONFIG_VALUE_EXTACT_DN_MODE, CONFIG_VALUE_FILTER_DESCRIPTOR_MODE, CONFIG_VALUE_SECURITY_USE_ACTIVE, CONFIG_VALUE_SECURITY_USE_INACTIVE, CONFIG_VALUE_SECURITY_USE_NOT_SELECTABLE, CONFIG_WILD_CHAR, CONFIG_WRITER_ROLE, CONIG_PROP_PROPERTY_FOR_INPUT, CONIG_PROP_PROPERTY_FOR_OUTPUT, COPYRIGHT_NOTICE, DISTINGUISHED_NAME, PROP_CHANGE_HANDLER_CLASS_NAME, PROPERTY_EXTENSION_REPOSITORY_ID, SCHEMA_SUBDIR, SCHEMAFILE_SUBDIR, VALUE_CONTEXT_FAILURE_REPOSITORY_IDS_KEY, WIM_CONFIG_NS_URI, WIM_POLICY_CONFIG_NS_URI
 
Method Summary
 commonj.sdo.DataObject getConfig()
          Gets all configuration data defined in virtual member manager configuration file.
 byte[] getConfigEPackage()
          Returns the DataGraph schema of virtual member manager configuration model in byte array.
 

Field Detail

SYS_PROP_WIM_HOME

static final java.lang.String SYS_PROP_WIM_HOME
The name of the system property for defining the virtual member manager home path. Virtual member manager home path contains all virtual member manager xml files and xsd files. The system property 'wim.home' will be looked up first. If it is not defined, the default path will be under system property 'user.install.root' + \config\cells\ + 'local.cell' + '\wim'.

See Also:
Constant Field Values

SYS_PROP_WIM_SCHEMA_HOME

static final java.lang.String SYS_PROP_WIM_SCHEMA_HOME
The name of the system property for defining the virtual member manager schema home path. Virtual member manager schema home path contains all virtual member manager schema files. The system property 'wim.schema.home' will be looked up first. If it is not defined, the default path will be under system property 'was.install.root' + \etc\wim\schema\ .

See Also:
Constant Field Values

WIM_HOME_CONFIG

static final java.lang.String WIM_HOME_CONFIG
The name of sub directory under virtual member manager home path which contains virtual member manager config files (wimconfig.xml and wimconfig.xsd)

See Also:
Constant Field Values

WIM_HOME_MODEL

static final java.lang.String WIM_HOME_MODEL
The name of sub directory under virtual member manager home path which contains virtual member manager model files (wimdomain.xsd, wimdatagraph.xsd)

See Also:
Constant Field Values

WIM_HOME_POLICY

static final java.lang.String WIM_HOME_POLICY
See Also:
Constant Field Values

WIM_CONFIG_XML_FILE_DEFAULT

static final java.lang.String WIM_CONFIG_XML_FILE_DEFAULT
The default name of the virtual member manager configuration file. If WMM_CONFIG_FILE is not defined, this name is used.

See Also:
Constant Field Values

WIM_MODEL_XSD_FILE_DEFAULT

static final java.lang.String WIM_MODEL_XSD_FILE_DEFAULT
The default name of the virtual member manager model extension XSD file.

See Also:
Constant Field Values

WIM_MODEL_PACKAGE_DEFAULT

static final java.lang.String WIM_MODEL_PACKAGE_DEFAULT
The default name of the virtual member manager data model package.

See Also:
Constant Field Values

WIM_CONFIG_SCHEMA_PACKAGE_NAME

static final java.lang.String WIM_CONFIG_SCHEMA_PACKAGE_NAME
The default name of the virtual member manager config model package.

See Also:
Constant Field Values

WIM_POLICY_CONFIG_SCHEMA_PACKAGE_NAME

static final java.lang.String WIM_POLICY_CONFIG_SCHEMA_PACKAGE_NAME
The default name of the virtual member manager Policy config model package.

See Also:
Constant Field Values

WIM_DEFAULT_POLICY_CONFIG

static final java.lang.String WIM_DEFAULT_POLICY_CONFIG
The name of the virtual member manager Default Policy config file.

See Also:
Constant Field Values

WIM_CUSTOM_POLICY_CONFIG

static final java.lang.String WIM_CUSTOM_POLICY_CONFIG
The name of the virtual member manager Custom Policy config file.

See Also:
Constant Field Values

ACTION_READ

static final java.lang.String ACTION_READ
See Also:
Constant Field Values

ACTION_CREATE

static final java.lang.String ACTION_CREATE
See Also:
Constant Field Values

ACTION_UPDATE

static final java.lang.String ACTION_UPDATE
See Also:
Constant Field Values

ACTION_DELETE

static final java.lang.String ACTION_DELETE
See Also:
Constant Field Values
Method Detail

getConfigEPackage

byte[] getConfigEPackage()
                         throws WIMException,
                                java.rmi.RemoteException
Returns the DataGraph schema of virtual member manager configuration model in byte array. ResourceSet can be used to convert the byte array to an EMF EPackage. The EPackage provides the vehicle for describing the DataGraph schema.

Throws:
WIMException
java.rmi.RemoteException
Return:
Byte array form of he DataGraph schema of virtual member manager configuration.

getConfig

commonj.sdo.DataObject getConfig()
                                 throws WIMException,
                                        java.rmi.RemoteException
Gets all configuration data defined in virtual member manager configuration file. The returned data object is 'configurationProvider'. It contains all configuration data defined in virtual member manager configuration file.

Throws:
WIMException - java.rmi.RemoteException
java.rmi.RemoteException
Return:
The 'configurationProvider' data object containing all configuration data.