org.gluu.oxtrust.action.UpdateAttributeAction クラス

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

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

公開メンバ関数
String	add ()
String	update ()
String	cancel ()
String	save ()
String	saveImpl ()
String	delete ()
void	cancelDeleteAndAcceptUpdate ()
String	deleteAndAcceptUpdate ()
boolean	validateEditType ()
boolean	validateName (String attributeName)
String	getInum ()
void	setInum (String inum)
GluuAttribute	getAttribute ()
boolean	isUpdate ()
boolean	isShowAttributeDeleteConfirmation ()
boolean	canEdit ()
boolean	isValidationToggle ()
void	setValidationToggle (boolean validationToggle)
boolean	isTooltipToggle ()
void	setTooltipToggle (boolean tooltipToggle)
void	setUpdate (boolean update)
void	setShowAttributeDeleteConfirmation (boolean showAttributeDeleteConfirmation)
boolean	isCanEdit ()
void	setCanEdit (boolean canEdit)

非公開メンバ関数
boolean	loadAttribute (String inum)
void	initAttribute ()
boolean	isAllowEdit ()
boolean	addNewAttribute (String attributeName, boolean addToSchema)
boolean	validateAttributeDefinition (String attributeName)
String	determineOrigin (String attributeName)
boolean	containsAttributeInGluuObjectClasses (String attributeName)

非公開変数類
Logger	log
AttributeService	attributeService
TrustService	trustService
SchemaService	schemaService
FacesMessages	facesMessages
ConversationService	conversationService
AppConfiguration	appConfiguration
Identity	identity
OxTrustAuditService	oxTrustAuditService
String	inum
GluuAttribute	attribute
boolean	update
boolean	showAttributeDeleteConfirmation
boolean	validationToggle
boolean	tooltipToggle
boolean	canEdit

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

詳解

Action class for updating attribute metadata

著者

Yuriy Movchan Date: 10.19.2010

関数詳解

add()

String org.gluu.oxtrust.action.UpdateAttributeAction.add ( )

inline

                            {
                if (this.attribute != null) {
                        return OxTrustConstants.RESULT_SUCCESS;
                }

                this.update = false;

                this.showAttributeDeleteConfirmation = false;

                this.attribute = new GluuAttribute();
                attribute.setAttributeValidation(new AttributeValidation());

                this.attribute.setStatus(GluuStatus.ACTIVE);
                this.attribute.setEditType(new UserRole[] { UserRole.ADMIN });

                this.canEdit = true;

                return OxTrustConstants.RESULT_SUCCESS;
        }

addNewAttribute()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.addNewAttribute ( String  attributeName, boolean  addToSchema  )

inlineprivate

                                                                                   {
                boolean attributeValidation = validateAttributeDefinition(attributeName);
                if (!attributeValidation) {
                        return false;
                }

                this.inum = attributeService.generateInumForNewAttribute();
                String dn = attributeService.getDnForAttribute(inum);
                if (attribute.getSaml1Uri() == null || attribute.getSaml1Uri().equals("")) {
                        attribute.setSaml1Uri("urn:gluu:dir:attribute-def:" + attributeName);
                }
                if (attribute.getSaml2Uri() == null || attribute.getSaml2Uri().equals("")) {
                        attribute.setSaml2Uri("urn:oid:" + attributeName);
                }

                String attributeOrigin = determineOrigin(attributeName);
                if (StringHelper.isEmpty(attributeOrigin)) {
                        facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to determine object class by attribute name");
                        return false;
                }

                this.attribute.setOrigin(attributeOrigin);

                // Save attribute metadata
                this.attribute.setDn(dn);
                this.attribute.setInum(inum);
                this.attribute.setDisplayName(this.attribute.getDisplayName().trim());
                this.attribute.setName(this.attribute.getName().trim());

                try {
                        attributeService.addAttribute(this.attribute);
                        oxTrustAuditService.audit("ATTRIBUTE " + this.attribute.getInum() + " **"+this.attribute.getDisplayName()+ "** ADDED",
                                        identity.getUser(),
                                        (HttpServletRequest) FacesContext.getCurrentInstance().getExternalContext().getRequest());
                } catch (BasePersistenceException ex) {
                        log.error("Failed to add new attribute {}", this.attribute.getInum(), ex);

                        facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to add new attribute");
                        return false;
                }

                return true;
        }

cancel()

String org.gluu.oxtrust.action.UpdateAttributeAction.cancel ( )

inline

                               {
                if (update) {
                        facesMessages.add(FacesMessage.SEVERITY_INFO, "Attribute '#{updateAttributeAction.attribute.displayName}' not updated");
                } else {
                        facesMessages.add(FacesMessage.SEVERITY_INFO, "New attribute not added");
                }

                conversationService.endConversation();

                return OxTrustConstants.RESULT_SUCCESS;
        }

cancelDeleteAndAcceptUpdate()

void org.gluu.oxtrust.action.UpdateAttributeAction.cancelDeleteAndAcceptUpdate ( )

inline

                                                  {
                showAttributeDeleteConfirmation = false;
        }

canEdit()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.canEdit ( )

inline

                                 {
                return canEdit;
        }

containsAttributeInGluuObjectClasses()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.containsAttributeInGluuObjectClasses ( String  attributeName )

inlineprivate

                                                                                   {
                String[] objectClasses = ArrayHelper.arrayMerge(new String[] { "gluuPerson" }, appConfiguration.getPersonObjectClassTypes());

                SchemaEntry schemaEntry = schemaService.getSchema();
                Set<String> attributeNames = schemaService.getObjectClassesAttributes(schemaEntry, objectClasses);

                String atributeNameToSearch = StringHelper.toLowerCase(attributeName);
                boolean result = attributeNames.contains(atributeNameToSearch);

                return result;
        }

delete()

String org.gluu.oxtrust.action.UpdateAttributeAction.delete ( )

inline

                               {
                showAttributeDeleteConfirmation = true;
                return deleteAndAcceptUpdate();
        }

deleteAndAcceptUpdate()

String org.gluu.oxtrust.action.UpdateAttributeAction.deleteAndAcceptUpdate ( )

inline

                                              {
                if (update && showAttributeDeleteConfirmation && this.attribute.isCustom()) {
                        showAttributeDeleteConfirmation = false;

                        if (trustService.removeAttribute(this.attribute)) {
                                oxTrustAuditService.audit("ATTRIBUTE " + this.attribute.getInum() + " **"+this.attribute.getDisplayName()+ "** REMOVED",
                                                identity.getUser(),
                                                (HttpServletRequest) FacesContext.getCurrentInstance().getExternalContext().getRequest());
                                facesMessages.add(FacesMessage.SEVERITY_INFO, "Attribute '#{updateAttributeAction.attribute.displayName}' removed successfully");
                                conversationService.endConversation();

                                return OxTrustConstants.RESULT_SUCCESS;
                        } else {
                                log.error("Failed to remove attribute {}", this.attribute.getInum());
                        }
                }

                showAttributeDeleteConfirmation = false;

                facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to remove attribute '#{updateAttributeAction.attribute.displayName}'");

                return OxTrustConstants.RESULT_FAILURE;
        }

determineOrigin()

String org.gluu.oxtrust.action.UpdateAttributeAction.determineOrigin ( String  attributeName )

inlineprivate

                                                             {
                String[] objectClasses = ArrayHelper.arrayMerge(new String[] { "gluuPerson" }, appConfiguration.getPersonObjectClassTypes());

                SchemaEntry schemaEntry = schemaService.getSchema();

                for (String objectClass : objectClasses) {
                        Set<String> attributeNames = schemaService.getObjectClassesAttributes(schemaEntry, new String[] { objectClass });
                        String atributeNameToSearch = StringHelper.toLowerCase(attributeName);
                        boolean contains = attributeNames.contains(atributeNameToSearch);
                        if (contains) {
                                return objectClass;
                        }
                }

                log.error("Failed to determine object class by attribute name '{}'", attributeName);
                return null;
        }

getAttribute()

GluuAttribute org.gluu.oxtrust.action.UpdateAttributeAction.getAttribute ( )

inline

                                            {
                return attribute;
        }

getInum()

String org.gluu.oxtrust.action.UpdateAttributeAction.getInum ( )

inline

                                {
                return inum;
        }

initAttribute()

void org.gluu.oxtrust.action.UpdateAttributeAction.initAttribute ( )

inlineprivate

                                     {
                if (StringHelper.isEmpty(this.attribute.getSaml1Uri())) {
                        String namespace;
                        if (attribute.isCustom()
                                        || StringHelper.isEmpty(attribute.getUrn()) && attribute.getUrn().startsWith("urn:gluu:dir:attribute-def:")) {
                                namespace = "gluu";
                        } else {
                                namespace = "mace";
                        }
                        this.attribute.setSaml1Uri(String.format("urn:%s:dir:attribute-def:%s", namespace, attribute.getName()));
                }

                if (StringHelper.isEmpty(this.attribute.getSaml2Uri())) {
                        this.attribute.setSaml2Uri(attributeService.getDefaultSaml2Uri(attribute.getName()));
                }

                if (attribute.getAttributeValidation() == null) {
                        attribute.setAttributeValidation(new AttributeValidation());
                } else {
                        this.validationToggle = true;
                }

                if (attribute.getGluuTooltip() != null) {
                        this.tooltipToggle = true;
                }
        }

isAllowEdit()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.isAllowEdit ( )

inlineprivate

                                      {
                return this.attribute.isAdminCanEdit();
        }

isCanEdit()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.isCanEdit ( )

inline

戻り値

the canEdit

                                   {
                return canEdit;
        }

isShowAttributeDeleteConfirmation()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.isShowAttributeDeleteConfirmation ( )

inline

                                                           {
                return showAttributeDeleteConfirmation;
        }

isTooltipToggle()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.isTooltipToggle ( )

inline

                                         {
                return tooltipToggle;
        }

isUpdate()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.isUpdate ( )

inline

                                  {
                return update;
        }

isValidationToggle()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.isValidationToggle ( )

inline

                                            {
                return validationToggle;
        }

loadAttribute()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.loadAttribute ( String  inum )

inlineprivate

                                                   {
                try {
                        this.attribute = attributeService.getAttributeByInum(inum);
                } catch (BasePersistenceException ex) {
                        log.error("Failed to find attribute {}", inum, ex);
                }

                if (this.attribute == null) {
                        return false;
                }

                initAttribute();

                this.canEdit = isAllowEdit();

                return true;
        }

save()

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

inline

                             {
                String outcome = saveImpl();
                
                if (update) {
                        if (OxTrustConstants.RESULT_SUCCESS.equals(outcome)) {
                                facesMessages.add(FacesMessage.SEVERITY_INFO, "Attribute '#{updateAttributeAction.attribute.displayName}' updated successfully");
                        } else if (OxTrustConstants.RESULT_FAILURE.equals(outcome)) {
                                facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to add new attribute");
                        }
                } else {
                        if (OxTrustConstants.RESULT_SUCCESS.equals(outcome)) {
                                facesMessages.add(FacesMessage.SEVERITY_INFO, "New attribute '#{updateAttributeAction.attribute.displayName}' added successfully");
                                conversationService.endConversation();
                        } else if (OxTrustConstants.RESULT_FAILURE.equals(outcome)) {
                                facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to update attribute '#{updateAttributeAction.attribute.displayName}'");
                        }
                }
                
                return outcome;
        }

saveImpl()

String org.gluu.oxtrust.action.UpdateAttributeAction.saveImpl ( )

inline

                                 {
                if (!tooltipToggle) {
                        attribute.setGluuTooltip(null);
                }

                if ((attribute.getEditType() != null) && (attribute.getEditType().length == 0)) {
                        attribute.setEditType(null);
                }

                if ((attribute.getViewType() != null) && (attribute.getViewType().length == 0)) {
                        attribute.setViewType(null);
                }

                String attributeName = this.attribute.getName();
                if (this.update) {
                        try {

                                boolean attributeValidation = validateAttributeDefinition(attributeName);
                                if (!attributeValidation) {
                                        return OxTrustConstants.RESULT_VALIDATION_ERROR;
                                }

                                attributeService.updateAttribute(this.attribute);
                                oxTrustAuditService.audit("ATTRIBUTE " + this.attribute.getInum() + " **"+this.attribute.getDisplayName()+ "** UPDATED",
                                                identity.getUser(),
                                                (HttpServletRequest) FacesContext.getCurrentInstance().getExternalContext().getRequest());
                        } catch (BasePersistenceException ex) {
                                log.error("Failed to update attribute {}", inum, ex);
                                facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to update attribute");
                                return OxTrustConstants.RESULT_FAILURE;
                        }
                } else {
                        if (!validateName(attributeName)) {
                                return OxTrustConstants.RESULT_FAILURE;
                        }

                        boolean result = addNewAttribute(attributeName, false);
                        if (!result) {
                                return OxTrustConstants.RESULT_FAILURE;
                        }
                }

                return OxTrustConstants.RESULT_SUCCESS;
        }

setCanEdit()

void org.gluu.oxtrust.action.UpdateAttributeAction.setCanEdit ( boolean  canEdit )

inline

引数

canEdit

the canEdit to set

                                                {
                this.canEdit = canEdit;
        }

setInum()

void org.gluu.oxtrust.action.UpdateAttributeAction.setInum ( String  inum )

inline

                                         {
                this.inum = inum;
        }

setShowAttributeDeleteConfirmation()

void org.gluu.oxtrust.action.UpdateAttributeAction.setShowAttributeDeleteConfirmation ( boolean  showAttributeDeleteConfirmation )

inline

引数

showAttributeDeleteConfirmation

the showAttributeDeleteConfirmation to set

                                                                                                {
                this.showAttributeDeleteConfirmation = showAttributeDeleteConfirmation;
        }

setTooltipToggle()

void org.gluu.oxtrust.action.UpdateAttributeAction.setTooltipToggle ( boolean  tooltipToggle )

inline

                                                            {
                this.tooltipToggle = tooltipToggle;
        }

setUpdate()

void org.gluu.oxtrust.action.UpdateAttributeAction.setUpdate ( boolean  update )

inline

引数

update

the update to set

                                              {
                this.update = update;
        }

setValidationToggle()

void org.gluu.oxtrust.action.UpdateAttributeAction.setValidationToggle ( boolean  validationToggle )

inline

                                                                  {
                this.validationToggle = validationToggle;
        }

update()

String org.gluu.oxtrust.action.UpdateAttributeAction.update ( )

inline

                               {
                if (this.attribute != null) {
                        return OxTrustConstants.RESULT_SUCCESS;
                }

                this.update = true;

                this.showAttributeDeleteConfirmation = false;

                if (!loadAttribute(this.inum)) {
                        facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to find attribute");
                        conversationService.endConversation();

                        return OxTrustConstants.RESULT_FAILURE;
                }

                return OxTrustConstants.RESULT_SUCCESS;
        }

validateAttributeDefinition()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.validateAttributeDefinition ( String  attributeName )

inlineprivate

                                                                          {
                boolean containsAttribute = schemaService.containsAttributeTypeInSchema(attributeName);
                if (!containsAttribute) {
                        facesMessages.add(FacesMessage.SEVERITY_ERROR, "The attribute type '#{updateAttributeAction.attribute.name}' not defined in LDAP schema");
                        return false;
                }

                // Check if attribute defined in gluuPerson or in custom object class
                boolean containsAttributeInGluuObjectClasses = containsAttributeInGluuObjectClasses(attributeName);
                if (!containsAttributeInGluuObjectClasses) {
                        facesMessages.add(FacesMessage.SEVERITY_ERROR, "Attribute type '#{updateAttributeAction.attribute.name}' definition not belong to list of allowed object classes");
                        return false;
                }

                return true;
        }

validateEditType()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.validateEditType ( )

inline

                                          {
                if (!(this.attribute.allowEditBy(UserRole.USER) || this.attribute.allowEditBy(UserRole.ADMIN))) {
                        facesMessages.add(FacesMessage.SEVERITY_WARN, "Please select Edit Type.");
                        return false;
                }

                return true;
        }

validateName()

boolean org.gluu.oxtrust.action.UpdateAttributeAction.validateName ( String  attributeName )

inline

                                                          {
                GluuAttribute tmpAttribute = new GluuAttribute();
                tmpAttribute.setBaseDn(attributeService.getDnForAttribute(null));
                tmpAttribute.setName(attributeName);

                if (attributeService.containsAttribute(tmpAttribute)) {
                        facesMessages.add("nameId", FacesMessage.SEVERITY_ERROR, "Attribute with specified name already exist");
                        return false;
                }

                return true;
        }

メンバ詳解

appConfiguration

AppConfiguration org.gluu.oxtrust.action.UpdateAttributeAction.appConfiguration

private

attribute

GluuAttribute org.gluu.oxtrust.action.UpdateAttributeAction.attribute

private

attributeService

AttributeService org.gluu.oxtrust.action.UpdateAttributeAction.attributeService

private

canEdit

boolean org.gluu.oxtrust.action.UpdateAttributeAction.canEdit

private

conversationService

ConversationService org.gluu.oxtrust.action.UpdateAttributeAction.conversationService

private

facesMessages

FacesMessages org.gluu.oxtrust.action.UpdateAttributeAction.facesMessages

private

identity

Identity org.gluu.oxtrust.action.UpdateAttributeAction.identity

private

inum

String org.gluu.oxtrust.action.UpdateAttributeAction.inum

private

log

Logger org.gluu.oxtrust.action.UpdateAttributeAction.log

private

oxTrustAuditService

OxTrustAuditService org.gluu.oxtrust.action.UpdateAttributeAction.oxTrustAuditService

private

schemaService

SchemaService org.gluu.oxtrust.action.UpdateAttributeAction.schemaService

private

serialVersionUID

final long org.gluu.oxtrust.action.UpdateAttributeAction.serialVersionUID = -2932167044333943687L

staticprivate

showAttributeDeleteConfirmation

boolean org.gluu.oxtrust.action.UpdateAttributeAction.showAttributeDeleteConfirmation

private

tooltipToggle

boolean org.gluu.oxtrust.action.UpdateAttributeAction.tooltipToggle

private

trustService

TrustService org.gluu.oxtrust.action.UpdateAttributeAction.trustService

private

update

boolean org.gluu.oxtrust.action.UpdateAttributeAction.update

private

validationToggle

boolean org.gluu.oxtrust.action.UpdateAttributeAction.validationToggle

private

---

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

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