org.gluu.oxtrust.action.ManageCustomScriptAction の継承関係図

org.gluu.oxtrust.action.ManageCustomScriptAction 連携図

公開メンバ関数
String	modify ()

String	save ()

String	cancel () throws Exception

Map< CustomScriptType, List< CustomScript > >	getCustomScriptsByTypes ()

String	getId (Object obj)

void	addCustomScript (CustomScriptType scriptType)

void	removeCustomScript (CustomScript removeCustomScript)

void	addItemToSimpleProperties (List< SimpleProperty > simpleProperties)

void	removeItemFromSimpleProperties (List< SimpleProperty > simpleProperties, SimpleProperty simpleProperty)

void	addItemToSimpleCustomProperties (List< SimpleCustomProperty > simpleCustomProperties)

void	removeItemFromSimpleCustomProperties (List< SimpleCustomProperty > simpleCustomProperties, SimpleCustomProperty simpleCustomProperty)

boolean	hasCustomScriptError (CustomScript customScript)

String	getCustomScriptError (CustomScript customScript)

boolean	isInitialized ()

非公開変数類
Logger	log

FacesMessages	facesMessages

ConversationService	conversationService

OrganizationService	organizationService

ApplianceService	applianceService

AbstractCustomScriptService	customScriptService

AppConfiguration	appConfiguration

Map< CustomScriptType, List< CustomScript > >	customScriptsByTypes

boolean	initialized

静的非公開変数類
static final long	serialVersionUID = -3823022039248381963L

static final Pattern	NAME_PATTERN = Pattern.compile("^[a-zA-Z0-9_]+$")

詳解

Add/Modify custom script configurations

著者: Yuriy Movchan Date: 12/29/2014

関数詳解

◆ addCustomScript()

void org.gluu.oxtrust.action.ManageCustomScriptAction.addCustomScript ( CustomScriptType scriptType )

inline

                                                                  {
                 List<CustomScript> customScriptsByType = this.customScriptsByTypes.get(scriptType);
 
                 CustomScript customScript;
                 if (CustomScriptType.PERSON_AUTHENTICATION == scriptType) {
                         AuthenticationCustomScript authenticationCustomScript = new AuthenticationCustomScript();
                         authenticationCustomScript.setModuleProperties(new ArrayList<SimpleCustomProperty>());
                         authenticationCustomScript.setUsageType(AuthenticationScriptUsageType.INTERACTIVE);
 
                         customScript = authenticationCustomScript;
                 } else {
                         customScript = new CustomScript();
                         customScript.setModuleProperties(new ArrayList<SimpleCustomProperty>());
                 }
 
                 customScript.setLocationType(ScriptLocationType.LDAP);
                 customScript.setScriptType(scriptType);
                 customScript.setProgrammingLanguage(ProgrammingLanguage.PYTHON);
                 customScript.setConfigurationProperties(new ArrayList<SimpleExtendedCustomProperty>());
 
                 customScriptsByType.add(customScript);
         }

◆ addItemToSimpleCustomProperties()

void org.gluu.oxtrust.action.ManageCustomScriptAction.addItemToSimpleCustomProperties ( List< SimpleCustomProperty > simpleCustomProperties )

inline

org.gluu.oxtrust.model.SimpleCustomPropertiesListModelを実装しています。

                                                                                                        {
                 if (simpleCustomProperties != null) {
                         simpleCustomProperties.add(new SimpleExtendedCustomProperty("", ""));
                 }
         }

◆ addItemToSimpleProperties()

void org.gluu.oxtrust.action.ManageCustomScriptAction.addItemToSimpleProperties ( List< SimpleProperty > simpleProperties )

inline

org.gluu.oxtrust.model.SimplePropertiesListModelを実装しています。

                                                                                      {
                 if (simpleProperties != null) {
                         simpleProperties.add(new SimpleProperty(""));
                 }
         }

◆ cancel()

String org.gluu.oxtrust.action.ManageCustomScriptAction.cancel ( ) throws Exception

inline

                                                 {
                 facesMessages.add(FacesMessage.SEVERITY_INFO, "Custom script configuration not updated");
 
                 conversationService.endConversation();
 
                 return OxTrustConstants.RESULT_SUCCESS;
         }

◆ getCustomScriptError()

String org.gluu.oxtrust.action.ManageCustomScriptAction.getCustomScriptError ( CustomScript customScript )

inline

                                                                       {
             if ((customScript == null) || (customScript.getDn() == null)) {
                 return null;
             }
 
             CustomScript currentScript = customScriptService.getCustomScriptByDn(customScript.getDn(), "oxScriptError");
             if ((currentScript != null) && (currentScript.getScriptError() != null)) {
                 return currentScript.getScriptError().getStackTrace();
             }
             
         return null;
         }

◆ getCustomScriptsByTypes()

Map<CustomScriptType, List<CustomScript> > org.gluu.oxtrust.action.ManageCustomScriptAction.getCustomScriptsByTypes ( )

inline

                                                                                    {
                 return this.customScriptsByTypes;
         }

◆ getId()

String org.gluu.oxtrust.action.ManageCustomScriptAction.getId ( Object obj )

inline

                                         {
                 return "c" + System.identityHashCode(obj) + "Id";
         }

◆ hasCustomScriptError()

boolean org.gluu.oxtrust.action.ManageCustomScriptAction.hasCustomScriptError ( CustomScript customScript )

inline

                                                                        {
             String error = getCustomScriptError(customScript);
         
         return error != null;
     }

◆ isInitialized()

boolean org.gluu.oxtrust.action.ManageCustomScriptAction.isInitialized ( )

inline

                                        {
                 return initialized;
         }

◆ modify()

String org.gluu.oxtrust.action.ManageCustomScriptAction.modify ( )

inline

                                {
                 if (this.initialized) {
                         return OxTrustConstants.RESULT_SUCCESS;
                 }
                 
                 CustomScriptType[] allowedCustomScriptTypes = this.applianceService.getCustomScriptTypes();
 
                 this.customScriptsByTypes = new HashMap<CustomScriptType, List<CustomScript>>();
                 for (CustomScriptType customScriptType : allowedCustomScriptTypes) {
                         this.customScriptsByTypes.put(customScriptType, new ArrayList<CustomScript>());
                 }
 
                 try {
                         List<CustomScript> customScripts = customScriptService.findCustomScripts(Arrays.asList(allowedCustomScriptTypes));
                         
                         for (CustomScript customScript : customScripts) {
                                 CustomScriptType customScriptType = customScript.getScriptType();
                                 List<CustomScript> customScriptsByType = this.customScriptsByTypes.get(customScriptType);
                                 
                                 CustomScript typedCustomScript = customScript;
                                 if (CustomScriptType.PERSON_AUTHENTICATION == customScriptType) {
                                         typedCustomScript = new AuthenticationCustomScript(customScript);
                                 }
 
                                 if (typedCustomScript.getConfigurationProperties() == null) {
                                         typedCustomScript.setConfigurationProperties(new ArrayList<SimpleExtendedCustomProperty>());
                                 }
                                 
                                 if (typedCustomScript.getModuleProperties() == null) {
                                         typedCustomScript.setModuleProperties(new ArrayList<SimpleCustomProperty>());
                                 }
 
                                 customScriptsByType.add(typedCustomScript);
                         }
                 } catch (Exception ex) {
                         log.error("Failed to load custom scripts ", ex);
                         facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to load custom scripts");
 
                         conversationService.endConversation();
 
                         return OxTrustConstants.RESULT_FAILURE;
                 }
 
                 this.initialized = true;
 
                 return OxTrustConstants.RESULT_SUCCESS;
         }

◆ removeCustomScript()

void org.gluu.oxtrust.action.ManageCustomScriptAction.removeCustomScript ( CustomScript removeCustomScript )

inline

                                                                         {
                 for (Entry<CustomScriptType, List<CustomScript>> customScriptsByType : this.customScriptsByTypes.entrySet()) {
                         List<CustomScript> customScripts = customScriptsByType.getValue();
                         for (Iterator<CustomScript> iterator = customScripts.iterator(); iterator.hasNext();) {
                                 CustomScript customScript = iterator.next();
                                 if (System.identityHashCode(removeCustomScript) == System.identityHashCode(customScript)) {
                                         iterator.remove();
                                         return;
                                 }
                         }
                 }
         }

◆ removeItemFromSimpleCustomProperties()

void org.gluu.oxtrust.action.ManageCustomScriptAction.removeItemFromSimpleCustomProperties	(	List< SimpleCustomProperty >	simpleCustomProperties,
		SimpleCustomProperty	simpleCustomProperty
	)

inline

org.gluu.oxtrust.model.SimpleCustomPropertiesListModelを実装しています。

                                                                                                                                                        {
                 if (simpleCustomProperties != null) {
                         simpleCustomProperties.remove(simpleCustomProperty);
                 }
         }

◆ removeItemFromSimpleProperties()

void org.gluu.oxtrust.action.ManageCustomScriptAction.removeItemFromSimpleProperties	(	List< SimpleProperty >	simpleProperties,
		SimpleProperty	simpleProperty
	)

inline

org.gluu.oxtrust.model.SimplePropertiesListModelを実装しています。

                                                                                                                          {
                 if (simpleProperties != null) {
                         simpleProperties.remove(simpleProperty);
                 }
         }

◆ save()

String org.gluu.oxtrust.action.ManageCustomScriptAction.save ( )

inline

                              {
                 try {
                         List<CustomScript> oldCustomScripts = customScriptService.findCustomScripts(Arrays.asList(this.applianceService.getCustomScriptTypes()), "dn", "inum");
 
                         List<String> updatedInums = new ArrayList<String>();
 
                         for (Entry<CustomScriptType, List<CustomScript>> customScriptsByType : this.customScriptsByTypes.entrySet()) {
                                 List<CustomScript> customScripts = customScriptsByType.getValue();
 
                                 for (CustomScript customScript : customScripts) {
                                         String configId = customScript.getName();
                                         if (StringHelper.equalsIgnoreCase(configId, OxConstants.SCRIPT_TYPE_INTERNAL_RESERVED_NAME)) {
                                                 facesMessages.add(FacesMessage.SEVERITY_ERROR, "'%s' is reserved script name", configId);
                                                 return OxTrustConstants.RESULT_FAILURE;
                                         }
                                         
                                         boolean nameValidation = NAME_PATTERN.matcher(customScript.getName()).matches();
                     if (!nameValidation) {
                         facesMessages.add(FacesMessage.SEVERITY_ERROR, "'%s' is invalid script name. Only alphabetic, numeric and underscore characters are allowed in Script Name", configId);
                         return OxTrustConstants.RESULT_FAILURE;
                     }
 
                     customScript.setRevision(customScript.getRevision() + 1);
 
                                         boolean update = true;
                                         String dn = customScript.getDn();
                                         String customScriptId = customScript.getInum();
                                         if (StringHelper.isEmpty(dn)) {
                                                 String basedInum = organizationService.getOrganizationInum();
                                                 customScriptId = basedInum + "!" + INumGenerator.generate(2);
                                                 dn = customScriptService.buildDn(customScriptId);
         
                                                 customScript.setDn(dn);
                                                 customScript.setInum(customScriptId);
                                                 update = false;
                                         };
 
                                         customScript.setDn(dn);
                                         customScript.setInum(customScriptId);
                                         
                                         if (ScriptLocationType.LDAP == customScript.getLocationType()) {
                                                 customScript.removeModuleProperty(CustomScript.LOCATION_PATH_MODEL_PROPERTY);
                                         }
                                         
                                         if ((customScript.getConfigurationProperties() != null) && (customScript.getConfigurationProperties().size() == 0)) {
                                                 customScript.setConfigurationProperties(null);
                                         }
                                         
                                         if ((customScript.getConfigurationProperties() != null) && (customScript.getModuleProperties().size() == 0)) {
                                                 customScript.setModuleProperties(null);
                                         }
                                         
                                         updatedInums.add(customScriptId);
         
                                         if (update) {
                                                 customScriptService.update(customScript);
                                         } else {
                                                 customScriptService.add(customScript);
                                         }
                                 }
                         }
                         
                         // Remove removed scripts
                         for (CustomScript oldCustomScript : oldCustomScripts) {
                                 if (!updatedInums.contains(oldCustomScript.getInum())) {
                                         customScriptService.remove(oldCustomScript);
                                 }
                         }
                 } catch (BasePersistenceException ex) {
                         log.error("Failed to update custom scripts", ex);
                         facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to update custom script configuration");
 
                         return OxTrustConstants.RESULT_FAILURE;
                 }
 
                 facesMessages.add(FacesMessage.SEVERITY_INFO, "Custom script configuration updated successfully");
 
                 return OxTrustConstants.RESULT_SUCCESS;
         }

メンバ詳解

◆ appConfiguration

AppConfiguration org.gluu.oxtrust.action.ManageCustomScriptAction.appConfiguration

private

◆ applianceService

ApplianceService org.gluu.oxtrust.action.ManageCustomScriptAction.applianceService

private

◆ conversationService

ConversationService org.gluu.oxtrust.action.ManageCustomScriptAction.conversationService

private

◆ customScriptsByTypes

Map<CustomScriptType, List<CustomScript> > org.gluu.oxtrust.action.ManageCustomScriptAction.customScriptsByTypes

private

◆ customScriptService

AbstractCustomScriptService org.gluu.oxtrust.action.ManageCustomScriptAction.customScriptService

private

◆ facesMessages

FacesMessages org.gluu.oxtrust.action.ManageCustomScriptAction.facesMessages

private

◆ initialized

boolean org.gluu.oxtrust.action.ManageCustomScriptAction.initialized

private

◆ log

Logger org.gluu.oxtrust.action.ManageCustomScriptAction.log

private

◆ NAME_PATTERN

final Pattern org.gluu.oxtrust.action.ManageCustomScriptAction.NAME_PATTERN = Pattern.compile("^[a-zA-Z0-9_]+$")

staticprivate

◆ organizationService

OrganizationService org.gluu.oxtrust.action.ManageCustomScriptAction.organizationService

private

◆ serialVersionUID

final long org.gluu.oxtrust.action.ManageCustomScriptAction.serialVersionUID = -3823022039248381963L

staticprivate

このクラス詳解は次のファイルから抽出されました:

D:/AppData/OpenId/gluu/src/oxTrust/server/src/main/java/org/gluu/oxtrust/action/ManageCustomScriptAction.java

公開メンバ関数

非公開変数類

静的非公開変数類

詳解

関数詳解

◆ addCustomScript()

◆ addItemToSimpleCustomProperties()

◆ addItemToSimpleProperties()

◆ cancel()

◆ getCustomScriptError()

◆ getCustomScriptsByTypes()

◆ getId()

◆ hasCustomScriptError()

◆ isInitialized()

◆ modify()

◆ removeCustomScript()

◆ removeItemFromSimpleCustomProperties()

◆ removeItemFromSimpleProperties()

◆ save()

メンバ詳解

◆ appConfiguration

◆ applianceService

◆ conversationService

◆ customScriptsByTypes

◆ customScriptService

◆ facesMessages

◆ initialized

◆ log

◆ NAME_PATTERN

◆ organizationService

◆ serialVersionUID