|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WIMServiceLocal
Local interface for Enterprise Bean: WIMService
Field Summary |
---|
Fields inherited from interface com.ibm.websphere.wim.ProfileService |
---|
ALL_LEVELS, ASSIGN_MODE, REPLACE_ASSIGN_MODE, UNASSIGN_MODE |
Fields inherited from interface com.ibm.websphere.wim.ConfigService |
---|
ACTION_CREATE, ACTION_DELETE, ACTION_READ, ACTION_UPDATE, SYS_PROP_WIM_HOME, SYS_PROP_WIM_SCHEMA_HOME, WIM_CONFIG_SCHEMA_PACKAGE_NAME, WIM_CONFIG_XML_FILE_DEFAULT, WIM_HOME_CONFIG, WIM_HOME_MODEL, WIM_MODEL_PACKAGE_DEFAULT, WIM_MODEL_XSD_FILE_DEFAULT |
Method Summary | |
---|---|
commonj.sdo.DataObject |
create(commonj.sdo.DataObject root)
Creates the entity under the given root data object. |
commonj.sdo.DataObject |
createDataObject(java.lang.String uri,
java.lang.String typeName)
Creates an empty data object of the given name space URI and type name. |
commonj.sdo.DataObject |
createRootDataObject()
Creates an empty root data object of virtual member manager. |
commonj.sdo.DataObject |
createSchema(commonj.sdo.DataObject root)
Creates the schema of new entity types and property types at runtime. |
commonj.sdo.DataObject |
delete(commonj.sdo.DataObject root)
Deletes the entity specified in the root data object. |
void |
dynamicUpdateConfig(java.lang.String updateEvent,
java.util.Hashtable configData)
Dynamically update configuration at runtime. |
commonj.sdo.DataObject |
get(commonj.sdo.DataObject root)
Returns information of the specified entity or entities. |
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. |
byte[] |
getEPackages(java.lang.String nsURI)
Returns the schema package from the given namespace URI in byte array form. |
commonj.sdo.DataObject |
getSchema(commonj.sdo.DataObject root)
Retrieves the schema of entity types and property types. |
commonj.sdo.DataObject |
login(commonj.sdo.DataObject root)
Authenticates the LoginAccount data object in the specified root data object. |
commonj.sdo.DataObject |
search(commonj.sdo.DataObject root)
Searches the profile repositories for entities matching the given search expression and returns them with the requested properties. |
commonj.sdo.DataObject |
update(commonj.sdo.DataObject root)
Updates entity specified in the root data object. |
Methods inherited from interface javax.ejb.EJBLocalObject |
---|
getEJBLocalHome, getPrimaryKey, isIdentical, remove |
Method Detail |
---|
byte[] getEPackages(java.lang.String nsURI) throws WIMException
SchemaService
SchemaConstants.WIM_NS_URI
).
to return build-in configuration schema package of virtual member manager, the namespace URI is "http://www.ibm.com/websphere/wim/config ((ConfigConstants.WIM_CONFIG_NS_URI
)".
Byte array form of the schema package can be converted back to the EPackage form. The EPackage provides the
vehicle for describing the schema of data graph.
Since byte array is serializable, this method can be used by remote clients to retrieve schema packages from service and register them in the local JVM.
getEPackages
in interface SchemaService
nsURI
- The name space URI of the schema package.
If nsURI is null, all schema packages related to virtual member manager will be returned, including build-in schema packge and custom schema packages.
WIMException
commonj.sdo.DataObject createRootDataObject() throws WIMException
SchemaService
DataObject root = service.getRootDataObject(); DataObject person = root.createDataObject("entities", "http://www.ibm.com/websphere/wim", "Person");The root data object can be used by client applications to build the input data object. An obvious use is to build input data object for creating entity through the create API.
createRootDataObject
in interface SchemaService
WIMException
commonj.sdo.DataObject createDataObject(java.lang.String uri, java.lang.String typeName) throws WIMException
SchemaService
createDataObject
in interface SchemaService
uri
- The name space URI of the type.typeName
- The name of the type.
WIMException
commonj.sdo.DataObject createSchema(commonj.sdo.DataObject root) throws WIMException
SchemaService
createSchema
in interface SchemaService
root
- The input root data object which contains the information of the new entity and property types. A schema data object is needed under root which contains
PropertySchema or EntitySchema.
A sample data graph for createSchema:
<Root> <schema>> <propertySchema nsPrefix="yourext" nsURI="http://www.yourco.com/yourext" dataType="String" multiValued="true" propertyName="cellPhone6"> <applicableEntityTypeNames>Person</applicableEntityTypeNames> <metaData name="repositoryPropertyName3"> <values>cellularTelephoneNumber3</values> </metaData> </propertySchema> </schema> </Root>For detail, please refer to the developer guideline.
WIMException
commonj.sdo.DataObject getSchema(commonj.sdo.DataObject root) throws WIMException
SchemaService
getSchema
in interface SchemaService
root
- The input root data object which contains the request controls. One of the following control is needed in the input data graph.
A sample data graph for getSchema:
<?xml version="1.0" encoding="UTF-8"?> <sdo:datagraph xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.ibm.com/websphere/wim" xmlns:sdo="commonj.sdo"> <Root> <controls xsi:type="PropertyDefinitionControl" repositoryId="LDAP1" entityTypeName="PersonAccount"/> </Root> </sdo:datagraph>Refer to the developer guideline for detail.
WIMException
commonj.sdo.DataObject create(commonj.sdo.DataObject root) throws WIMException
ProfileService
create
in interface ProfileService
root
- The root data object which contains the entity to be created.
WIMException
commonj.sdo.DataObject get(commonj.sdo.DataObject root) throws WIMException
ProfileService
get
in interface ProfileService
root
- The root data object containing the request information.
WIMException
commonj.sdo.DataObject delete(commonj.sdo.DataObject root) throws WIMException
ProfileService
delete
in interface ProfileService
root
- The root data object which contains the entity to delete.
The identifier of the entity should be specified.
WIMException
commonj.sdo.DataObject update(commonj.sdo.DataObject root) throws WIMException
ProfileService
update
in interface ProfileService
root
- The root data object containing entity with changes need to update.
WIMException
commonj.sdo.DataObject search(commonj.sdo.DataObject root) throws WIMException
ProfileService
search
in interface ProfileService
root
- the root data object containing the control(s) related to search.
WIMException
commonj.sdo.DataObject login(commonj.sdo.DataObject root) throws WIMException
ProfileService
login
in interface ProfileService
root
- the root data object containing the LoginAccount to authenticate.
WIMException
byte[] getConfigEPackage() throws WIMException
ConfigService
getConfigEPackage
in interface ConfigService
WIMException
commonj.sdo.DataObject getConfig() throws WIMException
ConfigService
getConfig
in interface ConfigService
WIMException
- java.rmi.RemoteExceptionvoid dynamicUpdateConfig(java.lang.String updateEvent, java.util.Hashtable configData) throws WIMException
DynamicConfigService
DynamicConfigConstants
dynamicUpdateConfig
in interface DynamicConfigService
updateEvent
- The type of the configuration update.configData
- The Hashtable which contains the data used for this type of configuration update.
WIMException
- DynamicUpdateConfigException and other WIMException specific to each event type.DynamicConfigConstants
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |