org.gluu.oxtrust.ldap.service.TrustService クラス

org.gluu.oxtrust.ldap.service.TrustService の継承関係図

org.gluu.oxtrust.ldap.service.TrustService 連携図

公開メンバ関数
void	addTrustRelationship (GluuSAMLTrustRelationship trustRelationship)
void	updateTrustRelationship (GluuSAMLTrustRelationship trustRelationship)
void	removeTrustRelationship (GluuSAMLTrustRelationship trustRelationship)
GluuSAMLTrustRelationship	getRelationshipByInum (String inum)
GluuSAMLTrustRelationship	getRelationshipByDn (String dn)
List< GluuSAMLTrustRelationship >	getAllTrustRelationships ()
List< GluuSAMLTrustRelationship >	getAllActiveTrustRelationships ()
List< GluuSAMLTrustRelationship >	getAllFederations ()
List< GluuSAMLTrustRelationship >	getAllOtherFederations (String inum)
boolean	containsTrustRelationship (GluuSAMLTrustRelationship trustRelationship)
String	generateInumForNewTrustRelationship ()
GluuMetadataSourceType []	getMetadataSourceTypes ()
String	getDnForTrustRelationShip (String inum)
void	updateReleasedAttributes (GluuSAMLTrustRelationship trustRelationship)
List< TrustContact >	getContacts (GluuSAMLTrustRelationship trustRelationship)
void	saveContacts (GluuSAMLTrustRelationship trustRelationship, List< TrustContact > contacts)
List< GluuSAMLTrustRelationship >	getDeconstructedTrustRelationships (GluuSAMLTrustRelationship trustRelationship)
GluuSAMLTrustRelationship	getTrustByUnpunctuatedInum (String unpunctuated)
GluuSAMLTrustRelationship	getTrustContainerFederation (GluuSAMLTrustRelationship trustRelationship)
GluuSAMLTrustRelationship	getTrustContainerFederation (String dn)
List< GluuSAMLTrustRelationship >	searchSAMLTrustRelationships (String pattern, int sizeLimit)
List< GluuSAMLTrustRelationship >	getAllSAMLTrustRelationships (int sizeLimit)
boolean	removeAttribute (GluuAttribute attribute)

静的公開変数類
static final String	GENERATED_SSL_ARTIFACTS_DIR = "ssl"

非公開メンバ関数
String	generateInumForNewTrustRelationshipImpl ()
String	getApplianceInum ()

非公開変数類
Logger	log
FacesMessages	facesMessages
PersistenceEntryManager	ldapEntryManager
AttributeService	attributeService
ApplianceService	applianceService
XmlService	xmlService
AppConfiguration	appConfiguration
MailService	mailService
RenderParameters	rendererParameters

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

詳解

Provides operations with trust relationships

著者

Pankaj

Yuriy Movchan Date: 11.05.2010

関数詳解

addTrustRelationship()

void org.gluu.oxtrust.ldap.service.TrustService.addTrustRelationship ( GluuSAMLTrustRelationship  trustRelationship )

inline

                                                                                      {
                trustRelationship.setGluuContainerFederation(trustRelationship.getGluuContainerFederation());
                String[] clusterMembers = appConfiguration.getClusteredInums();
                String applianceInum = appConfiguration.getApplianceInum();
                if (clusterMembers == null || clusterMembers.length == 0) {
                        log.debug("there is no cluster configuration. Assuming standalone appliance.");
                        clusterMembers = new String[] { applianceInum };
                }

                String dn = trustRelationship.getDn();
                for (String clusterMember : clusterMembers) {
                        String clusteredDN = StringHelper.replaceLast(dn, applianceInum, clusterMember);
                        trustRelationship.setDn(clusteredDN);
                        GluuSAMLTrustRelationship tr = new GluuSAMLTrustRelationship();
                        tr.setDn(trustRelationship.getDn());
                        if (!containsTrustRelationship(tr)) {
                                log.debug("Adding TR" + clusteredDN);
                                OrganizationalUnit ou = new OrganizationalUnit();
                                ou.setDn(getDnForTrustRelationShip(null));
                                if (!ldapEntryManager.contains(ou)) {
                                        ldapEntryManager.persist(ou);
                                }
                                ldapEntryManager.persist(trustRelationship);
                        } else {
                                ldapEntryManager.merge(trustRelationship);
                        }
                }
                trustRelationship.setDn(dn);
        }

containsTrustRelationship()

boolean org.gluu.oxtrust.ldap.service.TrustService.containsTrustRelationship ( GluuSAMLTrustRelationship  trustRelationship )

inline

Check if LDAP server contains trust relationship with specified attributes

戻り値

True if trust relationship with specified attributes exist

                                                                                              {
                return ldapEntryManager.contains(trustRelationship);
        }

generateInumForNewTrustRelationship()

String org.gluu.oxtrust.ldap.service.TrustService.generateInumForNewTrustRelationship ( )

inline

Generate new inum for trust relationship

戻り値

New inum for trust relationship

                                                            {
                InumEntry entry = new InumEntry();
                String newDn = appConfiguration.getBaseDN();
                entry.setDn(newDn);
                String newInum;
                do {
                        newInum = generateInumForNewTrustRelationshipImpl();
                        entry.setInum(newInum);
                } while (ldapEntryManager.contains(entry));

                return newInum;
        }

generateInumForNewTrustRelationshipImpl()

String org.gluu.oxtrust.ldap.service.TrustService.generateInumForNewTrustRelationshipImpl ( )

inlineprivate

Generate new inum for trust relationship

戻り値

New inum for trust relationship

                                                                 {
                return getApplianceInum() + OxTrustConstants.inumDelimiter + "0006" + OxTrustConstants.inumDelimiter
                                + INumGenerator.generate(2);
        }

getAllActiveTrustRelationships()

List<GluuSAMLTrustRelationship> org.gluu.oxtrust.ldap.service.TrustService.getAllActiveTrustRelationships ( )

inline

                                                                                {
                GluuSAMLTrustRelationship trustRelationship = new GluuSAMLTrustRelationship();
                trustRelationship.setBaseDn(getDnForTrustRelationShip(null));
                trustRelationship.setStatus(GluuStatus.ACTIVE);

                return ldapEntryManager.findEntries(trustRelationship);
        }

getAllFederations()

List<GluuSAMLTrustRelationship> org.gluu.oxtrust.ldap.service.TrustService.getAllFederations ( )

inline

                                                                   {
                List<GluuSAMLTrustRelationship> result = new ArrayList<GluuSAMLTrustRelationship>();
                for (GluuSAMLTrustRelationship trust : getAllActiveTrustRelationships()) {
                        if (trust.isFederation()) {
                                result.add(trust);
                        }
                }

                return result;
        }

getAllOtherFederations()

List<GluuSAMLTrustRelationship> org.gluu.oxtrust.ldap.service.TrustService.getAllOtherFederations ( String  inum )

inline

                                                                                   {
                List<GluuSAMLTrustRelationship> result = getAllFederations();
                result.remove(getRelationshipByInum(inum));
                return result;
        }

getAllSAMLTrustRelationships()

List<GluuSAMLTrustRelationship> org.gluu.oxtrust.ldap.service.TrustService.getAllSAMLTrustRelationships ( int  sizeLimit )

inline

                                                                                           {            
                        return ldapEntryManager.findEntries(getDnForTrustRelationShip(null), GluuSAMLTrustRelationship.class, null, sizeLimit);
        }

getAllTrustRelationships()

List<GluuSAMLTrustRelationship> org.gluu.oxtrust.ldap.service.TrustService.getAllTrustRelationships ( )

inline

This is a LDAP operation as LDAP and IDP will always be in sync. We can just call LDAP to fetch all Trust Relationships.

                                                                          {
                return ldapEntryManager.findEntries(getDnForTrustRelationShip(null), GluuSAMLTrustRelationship.class, null);
        }

getApplianceInum()

String org.gluu.oxtrust.ldap.service.TrustService.getApplianceInum ( )

inlineprivate

Return current organization inum

戻り値

Current organization inum

                                          {
                return appConfiguration.getApplianceInum();
        }

getContacts()

List<TrustContact> org.gluu.oxtrust.ldap.service.TrustService.getContacts ( GluuSAMLTrustRelationship  trustRelationship )

inline

                                                                                           {
                List<String> gluuTrustContacts = trustRelationship.getGluuTrustContact();
                List<TrustContact> contacts = new ArrayList<TrustContact>();
                if (gluuTrustContacts != null) {
                        for (String contact : gluuTrustContacts) {
                                contacts.add(xmlService.getTrustContactFromXML(contact));
                        }
                }
                return contacts;
        }

getDeconstructedTrustRelationships()

List<GluuSAMLTrustRelationship> org.gluu.oxtrust.ldap.service.TrustService.getDeconstructedTrustRelationships ( GluuSAMLTrustRelationship  trustRelationship )

inline

                                                                     {
                List<GluuSAMLTrustRelationship> result = new ArrayList<GluuSAMLTrustRelationship>();
                for (GluuSAMLTrustRelationship trust : getAllTrustRelationships()) {
                        if (trustRelationship.equals(getTrustContainerFederation(trust))) {
                                result.add(trust);
                        }
                }
                return result;
        }

getDnForTrustRelationShip()

String org.gluu.oxtrust.ldap.service.TrustService.getDnForTrustRelationShip ( String  inum )

inline

Build DN string for trust relationship

引数

inum

Inum

戻り値

DN string for specified trust relationship or DN for trust relationships branch if inum is null

                                                             {
                String applianceDN = applianceService.getDnForAppliance();
                if (StringHelper.isEmpty(inum)) {
                        return String.format("ou=trustRelationships,%s", applianceDN);
                }

                return String.format("inum=%s,ou=trustRelationships,%s", inum, applianceDN);
        }

getMetadataSourceTypes()

GluuMetadataSourceType [] org.gluu.oxtrust.ldap.service.TrustService.getMetadataSourceTypes ( )

inline

Get all metadata source types

戻り値

Array of metadata source types

                                                                 {
                return GluuMetadataSourceType.values();
        }

getRelationshipByDn()

GluuSAMLTrustRelationship org.gluu.oxtrust.ldap.service.TrustService.getRelationshipByDn ( String  dn )

inline

                                                                        {
                if (StringHelper.isNotEmpty(dn)) {
                        try {
                                return ldapEntryManager.find(GluuSAMLTrustRelationship.class, dn);
                        } catch (Exception e) {
                                log.info(e.getMessage());
                        }

                }
                return null;
        }

getRelationshipByInum()

GluuSAMLTrustRelationship org.gluu.oxtrust.ldap.service.TrustService.getRelationshipByInum ( String  inum )

inline

                                                                            {
                try {
                        return ldapEntryManager.find(GluuSAMLTrustRelationship.class, getDnForTrustRelationShip(inum));
                } catch (Exception e) {
                        log.error(e.getMessage());
                        return null;
                }

        }

getTrustByUnpunctuatedInum()

GluuSAMLTrustRelationship org.gluu.oxtrust.ldap.service.TrustService.getTrustByUnpunctuatedInum ( String  unpunctuated )

inline

                                                                                         {
                for (GluuSAMLTrustRelationship trust : getAllTrustRelationships()) {
                        if (StringHelper.removePunctuation(trust.getInum()).equals(unpunctuated)) {
                                return trust;
                        }
                }
                return null;
        }

getTrustContainerFederation() [1/2]

GluuSAMLTrustRelationship org.gluu.oxtrust.ldap.service.TrustService.getTrustContainerFederation ( GluuSAMLTrustRelationship  trustRelationship )

inline

                                                                                                                  {
                GluuSAMLTrustRelationship relationshipByDn = getRelationshipByDn(trustRelationship.getDn());
                return relationshipByDn;
        }

getTrustContainerFederation() [2/2]

GluuSAMLTrustRelationship org.gluu.oxtrust.ldap.service.TrustService.getTrustContainerFederation ( String  dn )

inline

                                                                                {
                GluuSAMLTrustRelationship relationshipByDn = getRelationshipByDn(dn);
                return relationshipByDn;
        }

removeAttribute()

boolean org.gluu.oxtrust.ldap.service.TrustService.removeAttribute ( GluuAttribute  attribute )

inline

Remove attribute

引数

attribute

Attribute

                                                                {
                log.info("Attribute removal started");

                log.trace("Removing attribute from trustRelationships");
                List<GluuSAMLTrustRelationship> trustRelationships = getAllTrustRelationships();
                log.trace(String.format("Iterating '%d' trustRelationships", trustRelationships.size()));
                for (GluuSAMLTrustRelationship trustRelationship : trustRelationships) {
                        log.trace("Analyzing '%s'.", trustRelationship.getDisplayName());
                        List<String> customAttrs = trustRelationship.getReleasedAttributes();
                        if (customAttrs != null) {
                                for (String attrDN : customAttrs) {
                                        log.trace("'%s' has custom attribute '%s'", trustRelationship.getDisplayName(), attrDN);
                                        if (attrDN.equals(attribute.getDn())) {
                                                log.trace("'%s' matches '%s'.  deleting it.", attrDN, attribute.getDn());
                                                List<String> updatedAttrs = new ArrayList<String>();
                                                updatedAttrs.addAll(customAttrs);
                                                updatedAttrs.remove(attrDN);
                                                if (updatedAttrs.size() == 0) {
                                                        trustRelationship.setReleasedAttributes(null);
                                                } else {
                                                        trustRelationship.setReleasedAttributes(updatedAttrs);
                                                }

                                                updateTrustRelationship(trustRelationship);
                                                break;
                                        }
                                }
                        }
                }

                attributeService.removeAttribute(attribute);

                return true;
        }

removeTrustRelationship()

void org.gluu.oxtrust.ldap.service.TrustService.removeTrustRelationship ( GluuSAMLTrustRelationship  trustRelationship )

inline

                                                                                         {
                log.info("Removing TR " + trustRelationship.getInum());
                String[] clusterMembers = appConfiguration.getClusteredInums();
                String applianceInum = appConfiguration.getApplianceInum();
                if (clusterMembers == null || clusterMembers.length == 0) {
                        log.debug("there is no cluster configuration. Assuming standalone appliance.");
                        clusterMembers = new String[] { applianceInum };
                }
                String dn = trustRelationship.getDn();
                for (String clusterMember : clusterMembers) {
                        String clusteredDN = StringHelper.replaceLast(dn, applianceInum, clusterMember);
                        trustRelationship.setDn(clusteredDN);
                        GluuSAMLTrustRelationship tr = new GluuSAMLTrustRelationship();
                        tr.setDn(trustRelationship.getDn());
                        if (containsTrustRelationship(tr)) {
                                log.debug("Removing TR" + clusteredDN);
                                ldapEntryManager.remove(trustRelationship);
                        }
                }
                trustRelationship.setDn(dn);

        }

saveContacts()

void org.gluu.oxtrust.ldap.service.TrustService.saveContacts ( GluuSAMLTrustRelationship  trustRelationship, List< TrustContact >  contacts  )

inline

                                                                                                           {
                if (contacts != null && !contacts.isEmpty()) {
                        List<String> gluuTrustContacts = new ArrayList<String>();
                        for (TrustContact contact : contacts) {
                                gluuTrustContacts.add(xmlService.getXMLFromTrustContact(contact));
                        }
                        trustRelationship.setGluuTrustContact(gluuTrustContacts);
                }
        }

searchSAMLTrustRelationships()

List<GluuSAMLTrustRelationship> org.gluu.oxtrust.ldap.service.TrustService.searchSAMLTrustRelationships ( String  pattern, int  sizeLimit  )

inline

                                                                                                           {
                String[] targetArray = new String[] { pattern };
                Filter displayNameFilter = Filter.createSubstringFilter(OxTrustConstants.displayName, null, targetArray, null);
                Filter descriptionFilter = Filter.createSubstringFilter(OxTrustConstants.description, null, targetArray, null);
                Filter inameFilter = Filter.createSubstringFilter(OxTrustConstants.iname, null, targetArray, null);
                Filter inumFilter = Filter.createSubstringFilter(OxTrustConstants.inum, null, targetArray, null);
                Filter searchFilter = Filter.createORFilter(displayNameFilter, descriptionFilter, inameFilter, inumFilter);

                List<GluuSAMLTrustRelationship> result = ldapEntryManager.findEntries(getDnForTrustRelationShip(null), GluuSAMLTrustRelationship.class, searchFilter, sizeLimit);

                return result;
        }

updateReleasedAttributes()

void org.gluu.oxtrust.ldap.service.TrustService.updateReleasedAttributes ( GluuSAMLTrustRelationship  trustRelationship )

inline

                                                                                          {
                List<String> releasedAttributes = new ArrayList<String>();

                String mailMsgPlain = "";
                String mailMsgHtml = "";
                for (GluuCustomAttribute customAttribute : trustRelationship.getReleasedCustomAttributes()) {
                        if (customAttribute.isNew()) {
                                rendererParameters.setParameter("attributeName", customAttribute.getName());
                                rendererParameters.setParameter("attributeDisplayName", customAttribute.getMetadata().getDisplayName());
                                rendererParameters.setParameter("attributeValue", customAttribute.getValue());

                                mailMsgPlain += facesMessages.evalResourceAsString("#{msg['mail.trust.released.attribute.plain']}");
                                mailMsgHtml += facesMessages.evalResourceAsString("#{msg['mail.trust.released.attribute.html']}");
                                rendererParameters.reset();

                                customAttribute.setNew(false);
                        }
                        releasedAttributes.add(customAttribute.getMetadata().getDn());
                }

                // send email notification
                if (!StringUtils.isEmpty(mailMsgPlain)) {
                        try {
                                GluuAppliance appliance = applianceService.getAppliance();

                                if (appliance.getContactEmail() == null || appliance.getContactEmail().isEmpty())
                                        log.warn("Failed to send the 'Attributes released' notification email: unconfigured contact email");
                                else if (appliance.getSmtpConfiguration() == null
                                                || StringHelper.isEmpty(appliance.getSmtpConfiguration().getHost()))
                                        log.warn("Failed to send the 'Attributes released' notification email: unconfigured SMTP server");
                                else {
                                        String subj = facesMessages.evalResourceAsString("#{msg['mail.trust.released.subject']}");

                                        rendererParameters.setParameter("trustRelationshipName", trustRelationship.getDisplayName());
                                        rendererParameters.setParameter("trustRelationshipInum", trustRelationship.getInum());

                                        String preMsgPlain = facesMessages.evalResourceAsString("#{msg['mail.trust.released.name.plain']}");
                                        String preMsgHtml = facesMessages.evalResourceAsString("#{msg['mail.trust.released.name.html']}");

                                        // rendererParameters.setParameter("mail_body", preMsgHtml + mailMsgHtml);
                                        // String mailHtml =
                                        // renderService.renderView("/WEB-INF/mail/trust_relationship.xhtml");

                                        boolean result = mailService.sendMail(appliance.getContactEmail(), null, subj,
                                                        preMsgPlain + mailMsgPlain, preMsgHtml + mailMsgHtml);

                                        if (!result) {
                                                log.error("Failed to send the notification email");
                                        }
                                }
                        } catch (Exception ex) {
                                log.error("Failed to send the notification email: ", ex);
                        }
                }

                if (!releasedAttributes.isEmpty()) {
                        trustRelationship.setReleasedAttributes(releasedAttributes);
                } else {
                        trustRelationship.setReleasedAttributes(null);
                }
        }

updateTrustRelationship()

void org.gluu.oxtrust.ldap.service.TrustService.updateTrustRelationship ( GluuSAMLTrustRelationship  trustRelationship )

inline

                                                                                         {
                log.debug("Updating TR " + trustRelationship.getInum());
                String[] clusterMembers = appConfiguration.getClusteredInums();
                String applianceInum = appConfiguration.getApplianceInum();
                if (clusterMembers == null || clusterMembers.length == 0) {
                        log.debug("there is no cluster configuration. Assuming standalone appliance.");
                        clusterMembers = new String[] { applianceInum };
                }
                String dn = trustRelationship.getDn();
                for (String clusterMember : clusterMembers) {
                        String clusteredDN = StringHelper.replaceLast(dn, applianceInum, clusterMember);
                        trustRelationship.setDn(clusteredDN);
                        GluuSAMLTrustRelationship tr = new GluuSAMLTrustRelationship();
                        tr.setDn(trustRelationship.getDn());
                        if (containsTrustRelationship(tr)) {
                                log.trace("Updating TR" + clusteredDN);
                                ldapEntryManager.merge(trustRelationship);
                        } else {
                                OrganizationalUnit ou = new OrganizationalUnit();
                                ou.setDn(getDnForTrustRelationShip(null));
                                if (!ldapEntryManager.contains(ou)) {
                                        ldapEntryManager.persist(ou);
                                }
                                ldapEntryManager.persist(trustRelationship);
                        }
                }
                trustRelationship.setDn(dn);
        }

メンバ詳解

appConfiguration

AppConfiguration org.gluu.oxtrust.ldap.service.TrustService.appConfiguration

private

applianceService

ApplianceService org.gluu.oxtrust.ldap.service.TrustService.applianceService

private

attributeService

AttributeService org.gluu.oxtrust.ldap.service.TrustService.attributeService

private

facesMessages

FacesMessages org.gluu.oxtrust.ldap.service.TrustService.facesMessages

private

GENERATED_SSL_ARTIFACTS_DIR

final String org.gluu.oxtrust.ldap.service.TrustService.GENERATED_SSL_ARTIFACTS_DIR = "ssl"

static

ldapEntryManager

PersistenceEntryManager org.gluu.oxtrust.ldap.service.TrustService.ldapEntryManager

private

log

Logger org.gluu.oxtrust.ldap.service.TrustService.log

private

mailService

MailService org.gluu.oxtrust.ldap.service.TrustService.mailService

private

rendererParameters

RenderParameters org.gluu.oxtrust.ldap.service.TrustService.rendererParameters

private

serialVersionUID

final long org.gluu.oxtrust.ldap.service.TrustService.serialVersionUID = -8128546040230316737L

staticprivate

xmlService

XmlService org.gluu.oxtrust.ldap.service.TrustService.xmlService

private

---

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

• D:/AppData/OpenId/gluu/src/oxTrust/server/src/main/java/org/gluu/oxtrust/ldap/service/TrustService.java