org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction クラス

org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction の継承関係図

org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction 連携図

公開メンバ関数
List< OxAuthClient >	getClientList ()
void	setClientList (List< OxAuthClient > clientList)
String	modify ()
String	cancel ()
String	save ()
String	delete ()
void	removeIconImage ()
void	destroy () throws Exception
void	setIconImage (FileUploadEvent event)
byte []	getIconImageThumbData ()
String	getIconImageSourceName ()
boolean	isIconExist ()
void	acceptSelectAuthorizationPolicies ()
void	cancelSelectAuthorizationPolicies ()
void	addAuthorizationPolicy (CustomScript addAuthorizationPolicy)
void	removeAuthorizationPolicy (CustomScript removeAuthorizationPolicy)
void	searchAvailableAuthorizationPolicies ()
boolean	isUpdate ()
String	getScopeInum ()
void	setScopeInum (String scopeInum)
UmaScopeDescription	getScopeDescription ()
List< SelectableEntity< CustomScript > >	getAvailableAuthorizationPolicies ()
List< CustomScript >	getAuthorizationPolicies ()

限定公開変数類
ScopeDescriptionService	scopeDescriptionService

非公開メンバ関数
String	add ()
String	update ()
void	setIconImageImpl (UploadedFile uploadedFile)
void	initIconImage ()
List< CustomScript >	getInitialAuthorizationPolicies ()
void	updateAuthorizationPolicies ()
void	selectAddedAuthorizationPolicies ()
Set< String >	getAddedAuthorizationPolicyInums ()

非公開変数類
Logger	log
FacesMessages	facesMessages
ConversationService	conversationService
Identity	identity
ImageService	imageService
JsonService	jsonService
LookupService	lookupService
CustomScriptService	customScriptService
UmaMetadata	umaMetadataConfiguration
ResourceSetService	resourceSetService
ClientService	clientService
String	scopeInum
UmaScopeDescription	scopeDescription
GluuImage	curIconImage
List< CustomScript >	authorizationPolicies
List< SelectableEntity< CustomScript > >	availableAuthorizationPolicies
boolean	update
List< OxAuthClient >	clientList

静的非公開変数類
static final long	serialVersionUID = 6180729281938167478L
static final String []	CUSTOM_SCRIPT_RETURN_ATTRIBUTES = { "inum", "displayName", "description" }

詳解

Action class for view and update UMA resource

著者

Yuriy Movchan Date: 11/21/2012

関数詳解

acceptSelectAuthorizationPolicies()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.acceptSelectAuthorizationPolicies ( )

inline

                                                        {
                if (this.availableAuthorizationPolicies == null) {
                        return;
                }

                Set<String> addedAuthorizationPolicyInums = getAddedAuthorizationPolicyInums();

                for (SelectableEntity<CustomScript> availableAuthorizationPolicy : this.availableAuthorizationPolicies) {
                        CustomScript authorizationPolicy = availableAuthorizationPolicy.getEntity();
                        if (availableAuthorizationPolicy.isSelected() && !addedAuthorizationPolicyInums.contains(authorizationPolicy.getInum())) {
                                addAuthorizationPolicy(authorizationPolicy);
                        }

                        if (!availableAuthorizationPolicy.isSelected() && addedAuthorizationPolicyInums.contains(authorizationPolicy.getInum())) {
                                removeAuthorizationPolicy(authorizationPolicy);
                        }
                }
        }

add()

String org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.add ( )

inlineprivate

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

                this.scopeDescription = new UmaScopeDescription();

                this.authorizationPolicies = getInitialAuthorizationPolicies();

                return OxTrustConstants.RESULT_SUCCESS;
        }

addAuthorizationPolicy()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.addAuthorizationPolicy ( CustomScript  addAuthorizationPolicy )

inline

                                                                                {
                if (addAuthorizationPolicy == null) {
                        return;
                }

                this.authorizationPolicies.add(addAuthorizationPolicy);
        }

cancel()

String org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.cancel ( )

inline

                               {
                if (update) {
                        facesMessages.add(FacesMessage.SEVERITY_INFO, "UMA resource '#{updateScopeDescriptionAction.scopeDescription.displayName}' not updated");
                } else {
                        facesMessages.add(FacesMessage.SEVERITY_INFO, "New UMA resource not added");
                }

                conversationService.endConversation();

                return OxTrustConstants.RESULT_SUCCESS;
        }

cancelSelectAuthorizationPolicies()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.cancelSelectAuthorizationPolicies ( )

inline

                                                        {
        }

delete()

String org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.delete ( )

inline

                               {
                if (update) {
                        // Remove scope description
                        try {
                                scopeDescriptionService.removeScopeDescription(this.scopeDescription);

                                facesMessages.add(FacesMessage.SEVERITY_INFO, "UMA resource '#{updateScopeDescriptionAction.scopeDescription.displayName}' removed successfully");
                                conversationService.endConversation();

                                return OxTrustConstants.RESULT_SUCCESS;
                        } catch (BasePersistenceException ex) {
                                log.error("Failed to remove scope description {}", this.scopeDescription.getId(), ex);
                        }
                }

                facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to remove UMA resource '#{updateScopeDescriptionAction.scopeDescription.displayName}'");

                return OxTrustConstants.RESULT_FAILURE;
        }

destroy()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.destroy ( ) throws Exception

inline

                                               {
                cancel();
        }

getAddedAuthorizationPolicyInums()

Set<String> org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.getAddedAuthorizationPolicyInums ( )

inlineprivate

                                                               {
                Set<String> addedAuthorizationPolicyInums = new HashSet<String>();

                for (CustomScript authorizationPolicy : this.authorizationPolicies) {
                        addedAuthorizationPolicyInums.add(authorizationPolicy.getInum());
                }

                return addedAuthorizationPolicyInums;
        }

getAuthorizationPolicies()

List<CustomScript> org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.getAuthorizationPolicies ( )

inline

                                                             {
                return authorizationPolicies;
        }

getAvailableAuthorizationPolicies()

List<SelectableEntity<CustomScript> > org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.getAvailableAuthorizationPolicies ( )

inline

                                                                                        {
                return this.availableAuthorizationPolicies;
        }

getClientList()

List<OxAuthClient> org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.getClientList ( )

inline

                                                  {
                return clientList;
        }

getIconImageSourceName()

String org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.getIconImageSourceName ( )

inline

                                               {
                if (this.curIconImage != null) {
                        return this.curIconImage.getSourceName();
                }

                return null;
        }

getIconImageThumbData()

byte [] org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.getIconImageThumbData ( )

inline

                                              {
                if ((this.curIconImage != null) && (this.curIconImage.getThumbData() != null)) {
                        return this.curIconImage.getThumbData();
                }

                return imageService.getBlankImageData();
        }

getInitialAuthorizationPolicies()

List<CustomScript> org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.getInitialAuthorizationPolicies ( )

inlineprivate

                                                                     {
                List<CustomScript> result = new ArrayList<CustomScript>();
                if ((this.scopeDescription.getAuthorizationPolicies() == null) || (this.scopeDescription.getAuthorizationPolicies().size() == 0)) {
                        return result;
                }

                List<DisplayNameEntry> displayNameEntries = lookupService.getDisplayNameEntries(customScriptService.baseDn(),
                                this.scopeDescription.getAuthorizationPolicies());
                if (displayNameEntries != null) {
                        for (DisplayNameEntry displayNameEntry : displayNameEntries) {
                                result.add(new CustomScript(displayNameEntry.getDn(), displayNameEntry.getInum(), displayNameEntry.getDisplayName()));
                        }
                }

                return result;
        }

getScopeDescription()

UmaScopeDescription org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.getScopeDescription ( )

inline

                                                         {
                return scopeDescription;
        }

getScopeInum()

String org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.getScopeInum ( )

inline

                                     {
                return scopeInum;
        }

initIconImage()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.initIconImage ( )

inlineprivate

                                     {
                String faviconImageAsXml = this.scopeDescription.getFaviconImageAsXml();
                if (StringHelper.isNotEmpty(faviconImageAsXml)) {
                        try {
                                this.curIconImage = jsonService.jsonToObject(faviconImageAsXml, GluuImage.class);
                        } catch (Exception ex) {
                                log.error("Faield to deserialize image: '{}'", faviconImageAsXml, ex);
                        }
                }
        }

isIconExist()

boolean org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.isIconExist ( )

inline

                                     {
                return this.curIconImage != null;
        }

isUpdate()

boolean org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.isUpdate ( )

inline

                                  {
                return update;
        }

modify()

String org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.modify ( )

inline

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

                this.update = StringHelper.isNotEmpty(this.scopeInum);

                try {
                        scopeDescriptionService.prepareScopeDescriptionBranch();
                } catch (BasePersistenceException ex) {
                        log.error("Failed to initialize form", ex);

                        if (update) {
                                facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to find UMA resource");
                        } else {
                                facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to add UMA resource");
                        }
                        conversationService.endConversation();

                        return OxTrustConstants.RESULT_FAILURE;
                }

                if (update) {
                        return update();
                } else {
                        return add();
                }
        }

removeAuthorizationPolicy()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.removeAuthorizationPolicy ( CustomScript  removeAuthorizationPolicy )

inline

                                                                                      {
                if (removeAuthorizationPolicy == null) {
                        return;
                }

                for (Iterator<CustomScript> it = this.authorizationPolicies.iterator(); it.hasNext();) {
                        CustomScript authorizationPolicy = (CustomScript) it.next();
                        
                        if (StringHelper.equalsIgnoreCase(removeAuthorizationPolicy.getInum(), authorizationPolicy.getInum())) {
                                it.remove();
                                break;
                        }
                }
        }

removeIconImage()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.removeIconImage ( )

inline

                                      {
                this.curIconImage = null;
                this.scopeDescription.setFaviconImageAsXml(null);
        }

save()

String org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.save ( )

inline

                             {
                updateAuthorizationPolicies();
                this.scopeDescription.setDisplayName(this.scopeDescription.getDisplayName().trim());

                if (this.update) {
                        // Update scope description
                        try {
                                scopeDescriptionService.updateScopeDescription(this.scopeDescription);
                        } catch (BasePersistenceException ex) {
                                log.error("Failed to update scope description '{}'", this.scopeDescription.getId(), ex);
                                facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to update UMA resource '#{updateScopeDescriptionAction.scopeDescription.displayName}'");
                                return OxTrustConstants.RESULT_FAILURE;
                        }

                log.debug("Scope description were updated successfully");
                        facesMessages.add(FacesMessage.SEVERITY_INFO, "UMA resource '#{updateScopeDescriptionAction.scopeDescription.displayName}' updated successfully");

                        return OxTrustConstants.RESULT_SUCCESS;
                } else {
                        // Check if scope description with this name already exist
                        UmaScopeDescription exampleScopeDescription = new UmaScopeDescription();
                        exampleScopeDescription.setDn(scopeDescriptionService.getDnForScopeDescription(null));
                        exampleScopeDescription.setId(scopeDescription.getId());

                        String inum = scopeDescriptionService.generateInumForNewScopeDescription();
                        String scopeDescriptionDn = scopeDescriptionService.getDnForScopeDescription(inum);

                        this.scopeDescription.setInum(inum);
                        this.scopeDescription.setDn(scopeDescriptionDn);
                        this.scopeDescription.setOwner(identity.getUser().getDn());
            this.scopeDescription.setId(scopeDescription.getId());

                        // Save scope description
                        try {
                                scopeDescriptionService.addScopeDescription(this.scopeDescription);
                        } catch (BasePersistenceException ex) {
                                log.error("Failed to add new UMA resource '{}'", this.scopeDescription.getId(), ex);
                                facesMessages.add(FacesMessage.SEVERITY_ERROR, "Failed to add new UMA resource");

                return OxTrustConstants.RESULT_FAILURE;
                        }

                log.debug("Scope description were add successfully");
                        facesMessages.add(FacesMessage.SEVERITY_INFO, "New UMA resource '#{updateScopeDescriptionAction.scopeDescription.displayName}' added successfully");
                        conversationService.endConversation();

                        this.update = true;
                        this.scopeInum = inum; 

                        return OxTrustConstants.RESULT_UPDATE;
                }
        }

searchAvailableAuthorizationPolicies()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.searchAvailableAuthorizationPolicies ( )

inline

                                                           {
                if (this.availableAuthorizationPolicies != null) {
                        selectAddedAuthorizationPolicies();
                        return;
                }

                try {
                        List<CustomScript> availableScripts = customScriptService.findCustomScripts(Arrays.asList(CustomScriptType.UMA_RPT_POLICY), CUSTOM_SCRIPT_RETURN_ATTRIBUTES);

                        List<SelectableEntity<CustomScript>> tmpAvailableAuthorizationPolicies = new ArrayList<SelectableEntity<CustomScript>>();
                        for (CustomScript authorizationPolicy : availableScripts) {
                                tmpAvailableAuthorizationPolicies.add(new SelectableEntity<CustomScript>(authorizationPolicy));
                        }
                        
                        this.availableAuthorizationPolicies = tmpAvailableAuthorizationPolicies;
                        selectAddedAuthorizationPolicies();
                } catch (BasePersistenceException ex) {
                        log.error("Failed to find available authorization policies", ex);
                }

        }

selectAddedAuthorizationPolicies()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.selectAddedAuthorizationPolicies ( )

inlineprivate

                                                        {
                Set<String> addedAuthorizationPolicyInums = getAddedAuthorizationPolicyInums();

                for (SelectableEntity<CustomScript> availableAuthorizationPolicy : this.availableAuthorizationPolicies) {
                        availableAuthorizationPolicy.setSelected(addedAuthorizationPolicyInums.contains(availableAuthorizationPolicy.getEntity().getInum()));
                }
        }

setClientList()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.setClientList ( List< OxAuthClient >  clientList )

inline

                                                                 {
                this.clientList = clientList;
        }

setIconImage()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.setIconImage ( FileUploadEvent  event )

inline

                                                        {
                UploadedFile uploadedFile = event.getUploadedFile();
                try {
                        setIconImageImpl(uploadedFile);
                } finally {
                        try {
                                uploadedFile.delete();
                        } catch (IOException ex) {
                                log.error("Failed to remove temporary image", ex);
                        }
                }
        }

setIconImageImpl()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.setIconImageImpl ( UploadedFile  uploadedFile )

inlineprivate

                                                                 {
                removeIconImage();

                GluuImage newIcon = imageService.constructImageWithThumbnail(identity.getUser(), uploadedFile, 16, 16);
                this.curIconImage = newIcon;
                try {
                        this.scopeDescription.setFaviconImageAsXml(jsonService.objectToJson(this.curIconImage));
                } catch (Exception ex) {
                        log.error("Failed to store icon image: '{}'", newIcon, ex);
                }
        }

setScopeInum()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.setScopeInum ( String  scopeInum )

inline

                                                   {
                this.scopeInum = scopeInum;
        }

update()

String org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.update ( )

inlineprivate

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

                log.debug("Loading UMA resource '{}'", this.scopeInum);
                try {
                        String scopeDn = scopeDescriptionService.getDnForScopeDescription(this.scopeInum);
                        this.scopeDescription = scopeDescriptionService.getScopeDescriptionByDn(scopeDn);
                        this.authorizationPolicies = getInitialAuthorizationPolicies();
                        
                        List<UmaResource> umaResourceList = resourceSetService.findResourcesByScope(scopeDn);
                        if (umaResourceList != null) {
                                for (UmaResource umaResource : umaResourceList) {
                                        List<String> list = umaResource.getClients();
                                        if (list != null) {
                                                clientList = new ArrayList<OxAuthClient>();
                                                for (String clientDn : list) {
                                                        OxAuthClient oxAuthClient = clientService.getClientByDn(clientDn);
                                                        clientList.add(oxAuthClient);
                                                }
                                        }
                                }
                        }
                } catch (BasePersistenceException ex) {
                        log.error("Failed to find scope description '{}'", this.scopeInum, ex);
                        return OxTrustConstants.RESULT_FAILURE;
                }

                if (this.scopeDescription == null) {
                        log.error("Scope description is null");
                        return OxTrustConstants.RESULT_FAILURE;
                }

                initIconImage();

                return OxTrustConstants.RESULT_SUCCESS;
        }

updateAuthorizationPolicies()

void org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.updateAuthorizationPolicies ( )

inlineprivate

                                                   {
                if (this.authorizationPolicies == null || this.authorizationPolicies.size() == 0) {
                        this.scopeDescription.setAuthorizationPolicies(null);
                        return;
                }

                List<String> tmpAuthorizationPolicies = new ArrayList<String>();
                for (CustomScript authorizationPolicy : this.authorizationPolicies) {
                        tmpAuthorizationPolicies.add(authorizationPolicy.getDn());
                }

                this.scopeDescription.setAuthorizationPolicies(tmpAuthorizationPolicies);
        }

メンバ詳解

authorizationPolicies

List<CustomScript> org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.authorizationPolicies

private

availableAuthorizationPolicies

List<SelectableEntity<CustomScript> > org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.availableAuthorizationPolicies

private

clientList

List<OxAuthClient> org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.clientList

private

clientService

ClientService org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.clientService

private

conversationService

ConversationService org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.conversationService

private

curIconImage

GluuImage org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.curIconImage

private

CUSTOM_SCRIPT_RETURN_ATTRIBUTES

final String [] org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.CUSTOM_SCRIPT_RETURN_ATTRIBUTES = { "inum", "displayName", "description" }

staticprivate

customScriptService

CustomScriptService org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.customScriptService

private

facesMessages

FacesMessages org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.facesMessages

private

identity

Identity org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.identity

private

imageService

ImageService org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.imageService

private

jsonService

JsonService org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.jsonService

private

log

Logger org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.log

private

lookupService

LookupService org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.lookupService

private

resourceSetService

ResourceSetService org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.resourceSetService

private

scopeDescription

UmaScopeDescription org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.scopeDescription

private

scopeDescriptionService

ScopeDescriptionService org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.scopeDescriptionService

protected

scopeInum

String org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.scopeInum

private

serialVersionUID

final long org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.serialVersionUID = 6180729281938167478L

staticprivate

umaMetadataConfiguration

UmaMetadata org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.umaMetadataConfiguration

private

update

boolean org.gluu.oxtrust.action.uma.UpdateScopeDescriptionAction.update

private

---

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

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