Quick Start (EJB mode): Creating Groups using the Java API

The following code example creates a group named AdobeGroup to LiveCycle. (See Creating Groups.)

/* 
    * This Java Quick Start uses the EJB mode and contains the following JAR files 
    * in the class path: 
    * 1. adobe-livecycle-client.jar 
    * 2. adobe-usermanager-client.jar 
    * 3. adobe-utilities.jar 
    * 4. jbossall-client.jar (use a different JAR file if the LiveCycle server is not deployed 
    * on JBoss) 
    * 5. jacorb.jar (use a different JAR file if the LiveCycle server is not deployed on JBoss) 
    * 6. jnp-client.jar (use a different JAR file if the LiveCycle server is not deployed on JBoss) 
    *  
    *  The JBoss files must be kept in the jboss\client folder. You can copy the client folder to  
    *  your local development environment and then include the 3 JBoss JAR files in your class path 
    *   
    *  These JAR files are located in the following path: 
    * <install directory>/sdk/client-libs/common 
    *  
    * The adobe-utilities.jar file is located in the following path: 
    * <install directory>/sdk/client-libs/jboss 
    *  
    * The jbossall-client.jar file is located in the following path: 
    * <install directory>/jboss/client 
    *  
    * If you want to invoke a remote LiveCycle server instance and there is a 
    * firewall between the client application and the server, then it is  
    * recommended that you use the SOAP mode. When using the SOAP mode,  
    * you have to include additional JAR files located in the following  
    * path 
    * <install directory>/sdk/client-libs/thirdparty 
    *  
    * For information about the SOAP  
    * mode and the additional JAR files that need to be included,  
    * see "Setting connection properties" in Programming  
    * with LiveCycle 
    *  
    * For complete details about the location of the LiveCycle JAR files,  
    * see "Including LiveCycle Java library files" in Programming  
    * with LiveCycle 
    */ 
import java.util.List; 
import java.util.Properties; 
 
import com.adobe.idp.dsc.clientsdk.ServiceClientFactory; 
import com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties; 
import com.adobe.idp.um.api.infomodel.Group; 
import com.adobe.idp.um.api.infomodel.Principal; 
import com.adobe.idp.um.api.infomodel.PrincipalSearchFilter; 
import com.adobe.idp.um.api.infomodel.PrincipalReference; 
import com.adobe.idp.um.api.infomodel.impl.GroupImpl; 
import com.adobe.livecycle.usermanager.client.DirectoryManagerServiceClient; 
 
public class AddGroup { 
 
    public static void main(String[] args) { 
         try { 
          
         //Set connection properties that are required to invoke LiveCycle 
         Properties connectionProps = new Properties(); 
                connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "jnp://hiro-xp:1099"); 
     connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);           
                connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss"); 
                connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator"); 
                connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password"); 
 
                 //Create a ServiceClientFactory object 
                 ServiceClientFactory myFactory = ServiceClientFactory.createInstance(connectionProps); 
 
                 //Create an DirectoryManagerServiceClient object 
                 DirectoryManagerServiceClient dmClient = new DirectoryManagerServiceClient(myFactory); 
 
                 //Specify the group and domain name 
                 String groupName = "AdobeGroup"; 
                 String domainName = "TestDomain"; 
                  
                 //Check whether the group exists 
                 String groupOid = checkGroupExist(groupName, domainName,dmClient); 
          
                 //The group exists 
                 if(groupOid != null){ 
                     System.out.println("The group exists"); 
                     return; 
                 } 
          
                 //The group does not exist 
                 String groupCanonicalName = groupName; 
 
                 GroupImpl group = new GroupImpl(); 
                 group.setCanonicalName(groupCanonicalName); 
                 group.setDomainName(domainName); 
                 group.setGroupType(Group.GROUPTYPE_PRINCIPALS); 
                 group.setLocal(true); 
                 group.setPrincipalType(Principal.PRINCIPALTYPE_GROUP); 
          
                 groupOid = dmClient.createLocalGroup(group); 
                 System.out.println("Sample group created with name "+groupName); 
 
         }catch (Exception e) { 
                e.printStackTrace(); 
            } 
 
        } 
     
    /** 
        * Search for a group located in the specified domain 
        */ 
       private static String checkGroupExist(String groupName, String domainName, DirectoryManagerServiceClient directoryManager){ 
         try { 
         PrincipalSearchFilter psf = new PrincipalSearchFilter(); 
           psf.setCommonName(groupName); 
           psf.setSpecificDomainName(domainName); 
     
           //By default the filter causes like search unless you are using the absolute version 
           //Setting this ensures that search is exact 
           psf.setMatchExactCriteria(true); 
     
           //By default search returns obsolete groups also. Set this to ensure that 
           //only active groups are returned 
           psf.setRetrieveOnlyActive();  
     
           //PrincipalReference are lightweight group objects and searching for them is better performance. 
           //If you do not require any other group attribute then use this 
           //mode of search 
           List<PrincipalReference> result = directoryManager.findPrincipalReferences(psf); 
           if(result.isEmpty()){ 
         System.out.println("Sample group with name "+groupName +" does not exist"); 
               return null; 
           }else{ 
               String oid = result.get(0).getOid();  
               System.out.println("Sample group with name "+groupName +" already exists"); 
               return oid; 
           } 
         }catch (Exception e) { 
               e.printStackTrace(); 
           } 
         return ""; 
       } 
}