com.ibm.bct.rp.cms
Class MemberXML

com.ibm.bct.rp.cms.MemberXML

public class MemberXML

The class MemberXML contains methods for performing basic operations on member objects in the WebSphere Member Subsystem.

Version:
1.10, 08/30/2002
Author:
Thomas W. Jaworski

Field Summary
protected static boolean bugpw
           
protected  java.util.Hashtable extAttributes
           
protected  java.lang.String iiopNode
           
protected static java.util.List KnownAttrib
           
protected  com.ibm.websphere.memberservice.datatype.MemberVO member
           
protected  com.ibm.hosting.clientStub.member.MemberPortType memberService
           
static java.lang.String PARTNER_SCOPE_LOCAL
          The PARTNER_SCOPE_* values are the valid values stored in the partnerScope attribute in OrgEntity members in WMS.
static java.lang.String PARTNER_SCOPE_REMOTE
           
static java.lang.String PARTNER_STATUS_ACTIVE
           
static java.lang.String PARTNER_STATUS_DEACTIVATED
           
static java.lang.String PARTNER_STATUS_DEACTIVATING
           
static java.lang.String PARTNER_STATUS_DELETED
           
static java.lang.String PARTNER_STATUS_GUEST
           
static java.lang.String PARTNER_STATUS_HOST
          The PARTNER_STATUS_* values are the valid values stored in the partnerStatus attribute in OrgEntity members in WMS.
static java.lang.String PARTNER_STATUS_PENDING
           
static java.lang.String SERV_DISERVICE_ENABLED
           
static java.lang.String SERV_DISERVICE_FILENAME
           
static java.lang.String SERV_DISERVICE_PREFIX
          The SERV_DISERVICE_PREFIX value is the prefix used for all DI Service related attributes in OrgEntity members in WMS.
static java.lang.String SERV_DOC_EXCHANGE_ENABLED
           
static java.lang.String SERV_DOC_EXCHANGE_PREFIX
          The SERV_DOC_EXCHANGE_PREFIX value is the prefix used for all Document Exchange Service related attributes in OrgEntity members in WMS.
static java.lang.String SERV_EBXML_ENABLED
           
static java.lang.String SERV_EBXML_PREFIX
          The SERV_EBXML_PREFIX value is the prefix used for all ebXML Service related attributes in OrgEntity members in WMS.
static java.lang.String SERV_PREFIX
          The SERV_PREFIX value is the prefix used for all service related attributes in OrgEntity members in WMS.
static java.lang.String SERV_PROFILE_UPLOAD_PREFIX
          The SERV_PROFILE_UPLOAD_PREFIX value is the prefix used for all Profile Upload Service related attributes in OrgEntity members in WMS.
static java.lang.String SERV_TPICONNECTOR_BINMIMETYPE
           
static java.lang.String SERV_TPICONNECTOR_EDIMIMETYPE
           
static java.lang.String SERV_TPICONNECTOR_ENABLED
           
static java.lang.String SERV_TPICONNECTOR_PREFIX
          The SERV_TPICONNECTOR_PREFIX value is the prefix used for all TPI Connector related attributes in OrgEntity members in WMS.
static java.lang.String SERV_TPICONNECTOR_XMLMIMETYPE
           
static java.lang.String SERV_TPISERVER_ENABLED
           
static java.lang.String SERV_TPISERVER_FILENAME
           
static java.lang.String SERV_TPISERVER_PREFIX
          The SERV_TPISERVER_PREFIX value is the prefix used for all TPI Server related attributes in OrgEntity members in WMS.
static java.lang.String SERV_WSGW_ENABLED
           
static java.lang.String SERV_WSGW_PREFIX
          The SERV_WSGW_PREFIX value is the prefix used for all Web Services Gateway Service related attributes in OrgEntity members in WMS.
protected  java.lang.String theMemberID
           
static java.lang.String USERDN_PREFIX
          The USERDN_PREFIX value is the prefix used for all user type members in WMS.
 
Constructor Summary
protected MemberXML()
          Default MemberXML constructor.
 
Method Summary
 boolean addAttributeValue(java.lang.String name, java.lang.String value)
          Add a string value to the List of values of an attribute.
 void deleteMember(java.lang.String MemberType, boolean includeDescendants)
          Delete a member record from WMS.
 java.util.List findMemberAttributes(java.lang.String MemberType, java.lang.String attrName, java.lang.String attrValue, java.lang.String searchAttr)
          Find all members based on an attribute value and return specific set of requested attributes.
 java.util.List findMembers(java.lang.String MemberType, java.lang.String attrName, java.lang.String attrValue)
          Find all members based on an attribute value.
static java.util.Map fromXML(java.lang.String topLevel, java.lang.String xml)
          Create an member object from XML to attribute Map.
 java.util.Map getAllAttributeValues()
          Get all attribute values.
 java.lang.String getAttributeValue(java.lang.String name)
          Get the 1st value of an attribute as string.
 java.lang.String getAttributeValue(java.lang.String name, java.lang.String defaultVal)
          Get the 1st value of an attribute as string or default value if attribute not set.
 java.util.List getAttributeValues(java.lang.String name)
          Get all the values of an attribute as a List.
 java.lang.String getIiopNode()
          Get the current node for MemberServices (depracated).
 java.lang.String getMemberID()
          Get the value of the unique member identifier.
 com.ibm.bct.rp.cms.MemberService getMemberService()
          Get a reference to the MemberServices access bean.
 java.lang.String getTypeFromValue(java.util.List vlist)
          Get the type name of value of list element.
protected  void init()
          Initialize MemberServices.
protected  void initIiop()
          Initialize IIOP node for CMS.
 java.util.Map removeBlankAttributes()
          Get all attribute values with blank (empty) attributes removed.
protected static void removeGarbage(java.util.Map attribList)
          Remove any generated attributes.
protected  void saveAttributeDef(java.lang.String name, java.lang.String type)
          Create and save in WMS an attribute definition.
 java.util.List searchMembers(java.lang.String MemberType, java.lang.String attrName, java.lang.String attrValue, java.util.List getAttr)
          Find all members based on an attribute value and return a list of attribute Maps.
 void setAllAttributeValues(java.util.Map attrib)
          Set all attribute values.
 boolean setAttributeValue(java.lang.String name, java.lang.String value)
          Set (replace) a List of values of an attribute with a single string value.
 boolean setAttributeValues(java.lang.String name, java.util.List vlist)
          Set (replace) a List of values of an attribute.
 void setIiopNode(java.lang.String theIiopNode)
          Set the node for MemberServices (depracated)
protected static java.util.List setOperator(java.lang.String operator, java.util.List list)
          Setup operation for WMS search operations from a List.
protected static java.util.List setOperator(java.lang.String operator, java.lang.String item)
          Setup operation for WMS search operations from a string.
static java.lang.String toAttribXML(java.lang.String topLevel, java.util.List attrList, java.util.Map attrib)
          Convert an attribute map to XML with values output as XML tag attributes.
protected static java.lang.String toXML(java.lang.String topLevel, java.util.Map attrib)
          Convert an attribute map to XML.
 void updateExtAttributes()
          Update the values of all attributes for this object in WMS.
 

Field Detail

bugpw

protected static boolean bugpw

USERDN_PREFIX

public static final java.lang.String USERDN_PREFIX
The USERDN_PREFIX value is the prefix used for all user type members in WMS.

PARTNER_SCOPE_LOCAL

public static final java.lang.String PARTNER_SCOPE_LOCAL
The PARTNER_SCOPE_* values are the valid values stored in the partnerScope attribute in OrgEntity members in WMS.

PARTNER_SCOPE_REMOTE

public static final java.lang.String PARTNER_SCOPE_REMOTE

PARTNER_STATUS_HOST

public static final java.lang.String PARTNER_STATUS_HOST
The PARTNER_STATUS_* values are the valid values stored in the partnerStatus attribute in OrgEntity members in WMS.

PARTNER_STATUS_GUEST

public static final java.lang.String PARTNER_STATUS_GUEST

PARTNER_STATUS_PENDING

public static final java.lang.String PARTNER_STATUS_PENDING

PARTNER_STATUS_ACTIVE

public static final java.lang.String PARTNER_STATUS_ACTIVE

PARTNER_STATUS_DEACTIVATING

public static final java.lang.String PARTNER_STATUS_DEACTIVATING

PARTNER_STATUS_DEACTIVATED

public static final java.lang.String PARTNER_STATUS_DEACTIVATED

PARTNER_STATUS_DELETED

public static final java.lang.String PARTNER_STATUS_DELETED

SERV_PREFIX

public static final java.lang.String SERV_PREFIX
The SERV_PREFIX value is the prefix used for all service related attributes in OrgEntity members in WMS.

SERV_PROFILE_UPLOAD_PREFIX

public static final java.lang.String SERV_PROFILE_UPLOAD_PREFIX
The SERV_PROFILE_UPLOAD_PREFIX value is the prefix used for all Profile Upload Service related attributes in OrgEntity members in WMS.

SERV_DOC_EXCHANGE_PREFIX

public static final java.lang.String SERV_DOC_EXCHANGE_PREFIX
The SERV_DOC_EXCHANGE_PREFIX value is the prefix used for all Document Exchange Service related attributes in OrgEntity members in WMS.

SERV_DOC_EXCHANGE_ENABLED

public static final java.lang.String SERV_DOC_EXCHANGE_ENABLED

SERV_WSGW_PREFIX

public static final java.lang.String SERV_WSGW_PREFIX
The SERV_WSGW_PREFIX value is the prefix used for all Web Services Gateway Service related attributes in OrgEntity members in WMS.

SERV_WSGW_ENABLED

public static final java.lang.String SERV_WSGW_ENABLED

SERV_TPISERVER_PREFIX

public static final java.lang.String SERV_TPISERVER_PREFIX
The SERV_TPISERVER_PREFIX value is the prefix used for all TPI Server related attributes in OrgEntity members in WMS.

SERV_TPISERVER_ENABLED

public static final java.lang.String SERV_TPISERVER_ENABLED

SERV_TPISERVER_FILENAME

public static final java.lang.String SERV_TPISERVER_FILENAME

SERV_TPICONNECTOR_PREFIX

public static final java.lang.String SERV_TPICONNECTOR_PREFIX
The SERV_TPICONNECTOR_PREFIX value is the prefix used for all TPI Connector related attributes in OrgEntity members in WMS.

SERV_TPICONNECTOR_ENABLED

public static final java.lang.String SERV_TPICONNECTOR_ENABLED

SERV_TPICONNECTOR_XMLMIMETYPE

public static final java.lang.String SERV_TPICONNECTOR_XMLMIMETYPE

SERV_TPICONNECTOR_EDIMIMETYPE

public static final java.lang.String SERV_TPICONNECTOR_EDIMIMETYPE

SERV_TPICONNECTOR_BINMIMETYPE

public static final java.lang.String SERV_TPICONNECTOR_BINMIMETYPE

SERV_DISERVICE_PREFIX

public static final java.lang.String SERV_DISERVICE_PREFIX
The SERV_DISERVICE_PREFIX value is the prefix used for all DI Service related attributes in OrgEntity members in WMS.

SERV_DISERVICE_ENABLED

public static final java.lang.String SERV_DISERVICE_ENABLED

SERV_DISERVICE_FILENAME

public static final java.lang.String SERV_DISERVICE_FILENAME

SERV_EBXML_PREFIX

public static final java.lang.String SERV_EBXML_PREFIX
The SERV_EBXML_PREFIX value is the prefix used for all ebXML Service related attributes in OrgEntity members in WMS.

SERV_EBXML_ENABLED

public static final java.lang.String SERV_EBXML_ENABLED

memberService

protected com.ibm.hosting.clientStub.member.MemberPortType memberService

iiopNode

protected java.lang.String iiopNode

extAttributes

protected java.util.Hashtable extAttributes

theMemberID

protected java.lang.String theMemberID

member

protected com.ibm.websphere.memberservice.datatype.MemberVO member

KnownAttrib

protected static java.util.List KnownAttrib
Constructor Detail

MemberXML

protected MemberXML()
Default MemberXML constructor.
Method Detail

initIiop

protected void initIiop()
Initialize IIOP node for CMS.

init

protected void init()
Initialize MemberServices.

removeGarbage

protected static void removeGarbage(java.util.Map attribList)
Remove any generated attributes.
Parameters:
java.util.Map - attribList - Map of attributes to remove from.

removeBlankAttributes

public java.util.Map removeBlankAttributes()
Get all attribute values with blank (empty) attributes removed.
Returns:
java.util.Map - Map of attributes with blank (empty) attributes removed.

getMemberID

public java.lang.String getMemberID()
Get the value of the unique member identifier.
Returns:
java.lang.String - Value of the uniqueMemberIdentifier.

setIiopNode

public void setIiopNode(java.lang.String theIiopNode)
Set the node for MemberServices (depracated)
Parameters:
java.lang.String - theIiopNode - The IIOP node of the WMS to access (null=use "localhost").

getIiopNode

public java.lang.String getIiopNode()
Get the current node for MemberServices (depracated).
Returns:
java.lang.String - The IIOP node of the WMS to access.

getMemberService

public com.ibm.bct.rp.cms.MemberService getMemberService()
Get a reference to the MemberServices access bean.
Returns:
com.ibm.websphere.memberservice.objects.MemberService - The MemberService access bean.

setOperator

protected static java.util.List setOperator(java.lang.String operator,
                                            java.lang.String item)
Setup operation for WMS search operations from a string.
Parameters:
input - java.lang.String operator - Operator for operation.
input - java.lang.String item - Item Value for operation.
Returns:
java.util.List - The operation for search.

setOperator

protected static java.util.List setOperator(java.lang.String operator,
                                            java.util.List list)
Setup operation for WMS search operations from a List.
Parameters:
input - java.lang.String operator - Operator for operation.
input - java.util.List list - ItemValue list for operation.
Returns:
java.util.List - The operation for search.

getTypeFromValue

public java.lang.String getTypeFromValue(java.util.List vlist)
Get the type name of value of list element.
Parameters:
input - java.util.List list - List element.
Returns:
java.lang.String - The type name of the value.

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name)
Get the 1st value of an attribute as string.
Parameters:
input - java.lang.String name - The name of the attribute.
Returns:
java.lang.String - The string value of the attribute.

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name,
                                          java.lang.String defaultVal)
Get the 1st value of an attribute as string or default value if attribute not set.
Parameters:
input - java.lang.String name - The name of the attribute.
input - java.lang.String defaultVal - Default value to return if attribute not set.
Returns:
java.lang.String - The string value of the attribute.

getAttributeValues

public java.util.List getAttributeValues(java.lang.String name)
Get all the values of an attribute as a List.
Parameters:
input - java.lang.String name - The name of the attribute.
Returns:
java.util.List - The values of the attribute as a List.

addAttributeValue

public boolean addAttributeValue(java.lang.String name,
                                 java.lang.String value)
Add a string value to the List of values of an attribute.
Parameters:
input - java.lang.String name - The name of the attribute.
input - java.lang.String value - Value to add to value list for attribute.
Returns:
boolean - Success status.

setAttributeValue

public boolean setAttributeValue(java.lang.String name,
                                 java.lang.String value)
Set (replace) a List of values of an attribute with a single string value.
Parameters:
input - java.lang.String name - The name of the attribute.
input - java.lang.String value - Value to set the value list from, for the attribute.
Returns:
boolean - success status

setAttributeValues

public boolean setAttributeValues(java.lang.String name,
                                  java.util.List vlist)
Set (replace) a List of values of an attribute.
Parameters:
input - java.lang.String name - The name of the attribute.
input - java.util.List vlist - List of values to set for the attribute.
Returns:
boolean - Success status.

getAllAttributeValues

public java.util.Map getAllAttributeValues()
Get all attribute values.
Returns:
java.util.Map - Map of all the attribute values.

setAllAttributeValues

public void setAllAttributeValues(java.util.Map attrib)
Set all attribute values.
Parameters:
input - java.util.Map - Map of all the attribute values.

saveAttributeDef

protected void saveAttributeDef(java.lang.String name,
                                java.lang.String type)
Create and save in WMS an attribute definition.
Parameters:
input - java.lang.String name - The name of the attribute.
input - java.lang.String type - The data type name for the attribute.

updateExtAttributes

public void updateExtAttributes()
                         throws com.ibm.bct.rp.cms.MemberServiceException,
                                java.rmi.RemoteException,
                                com.ibm.bct.rp.cms.CreateException,
                                com.ibm.bct.rp.cms.NamingException
Update the values of all attributes for this object in WMS.
Throws:
com.ibm.websphere.memberservice.exception.MemberServiceException -  
java.rmi.RemoteException -  
javax.ejb.CreateException -  
javax.naming.NamingException -  

deleteMember

public void deleteMember(java.lang.String MemberType,
                         boolean includeDescendants)
                  throws com.ibm.bct.rp.cms.MemberServiceException,
                         java.rmi.RemoteException,
                         com.ibm.bct.rp.cms.CreateException,
                         com.ibm.bct.rp.cms.NamingException
Delete a member record from WMS.
Parameters:
input - java.lang.String MemberType - The type of member.
input - boolean includeDescendants - Delete desendent objects.
Throws:
com.ibm.websphere.memberservice.exception.MemberServiceException -  
java.rmi.RemoteException -  
javax.ejb.CreateException -  
javax.naming.NamingException -  

findMembers

public java.util.List findMembers(java.lang.String MemberType,
                                  java.lang.String attrName,
                                  java.lang.String attrValue)
                           throws com.ibm.bct.rp.cms.MemberServiceException,
                                  java.rmi.RemoteException,
                                  com.ibm.bct.rp.cms.CreateException,
                                  com.ibm.bct.rp.cms.NamingException
Find all members based on an attribute value.
Parameters:
input - java.lang.String MemberType - The type of member.
input - java.lang.String attrName - The name of the attribute to search on.
input - java.lang.String attrValue - The value to search for.
Returns:
java.util.List - List of resultant unique member identifiers.
Throws:
com.ibm.websphere.memberservice.exception.MemberServiceException -  
java.rmi.RemoteException -  
javax.ejb.CreateException -  
javax.naming.NamingException -  

findMemberAttributes

public java.util.List findMemberAttributes(java.lang.String MemberType,
                                           java.lang.String attrName,
                                           java.lang.String attrValue,
                                           java.lang.String searchAttr)
                                    throws com.ibm.bct.rp.cms.MemberServiceException,
                                           java.rmi.RemoteException,
                                           com.ibm.bct.rp.cms.CreateException,
                                           com.ibm.bct.rp.cms.NamingException
Find all members based on an attribute value and return specific set of requested attributes.
Parameters:
input - java.lang.String MemberType - The type of member.
input - java.lang.String attrName - The name of the attribute to search on.
input - java.lang.String attrValue - The value to search for.
input - java.lang.String searchAttr - The attribute name of the value to return.
Returns:
java.util.List - List of resultant requested attribute values.
Throws:
com.ibm.websphere.memberservice.exception.MemberServiceException -  
java.rmi.RemoteException -  
javax.ejb.CreateException -  
javax.naming.NamingException -  

searchMembers

public java.util.List searchMembers(java.lang.String MemberType,
                                    java.lang.String attrName,
                                    java.lang.String attrValue,
                                    java.util.List getAttr)
                             throws com.ibm.bct.rp.cms.MemberServiceException,
                                    java.rmi.RemoteException,
                                    com.ibm.bct.rp.cms.CreateException,
                                    com.ibm.bct.rp.cms.NamingException
Find all members based on an attribute value and return a list of attribute Maps.
Parameters:
input - java.lang.String MemberType - The type of member.
input - java.lang.String attrName - The name of the attribute to search on.
input - java.lang.String attrValue - The value to search for.
input - java.util.List getAttr - A list of attribute names of the values to return.
Returns:
java.util.List - List of resultant requested attribute Maps.
Throws:
com.ibm.websphere.memberservice.exception.MemberServiceException -  
java.rmi.RemoteException -  
javax.ejb.CreateException -  
javax.naming.NamingException -  

toAttribXML

public static java.lang.String toAttribXML(java.lang.String topLevel,
                                           java.util.List attrList,
                                           java.util.Map attrib)
Convert an attribute map to XML with values output as XML tag attributes.
Parameters:
input - java.lang.String topLevel - Top level tag.
input - java.util.List attrib - List of Attribute names to output.
input - java.util.Map attrib - Map of Attribute values.
Returns:
java.lang.String - XML string representation of attributes.

toXML

protected static java.lang.String toXML(java.lang.String topLevel,
                                        java.util.Map attrib)
Convert an attribute map to XML.
Parameters:
input - java.lang.String topLevel - Top level tag.
input - java.util.Map attrib - Map of Attribute values.
Returns:
java.lang.String - XML string representation of attributes.

fromXML

public static java.util.Map fromXML(java.lang.String topLevel,
                                    java.lang.String xml)
Create an member object from XML to attribute Map.
Parameters:
input - java.lang.String topLevel - Top level tag.
input - java.lang.String xml - XML string to get definition from.
Returns:
java.lang.boolean - success status.