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

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

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

公開メンバ関数
boolean	contains (String clientDn)
void	addClient (OxAuthClient client)
void	removeClient (OxAuthClient client)
OxAuthClient	getClientByInum (String inum, String... ldapReturnAttributes)
OxAuthCustomClient	getClientByInumCustom (String inum)
String	getDnForClient (String inum)
void	updateClient (OxAuthClient client)
void	updateCustomClient (OxAuthCustomClient client)
String	generateInumForNewClient ()
String	generateInameForNewClient (String name)
List< OxAuthClient >	searchClients (String pattern, int sizeLimit)
List< OxAuthClient >	getAllClients (int sizeLimit)
List< OxAuthClient >	getAllClients ()
OxAuthClient	getClientByDn (String Dn)
OxAuthCustomClient	getClientByDnCustom (String Dn)
OxAuthClient	getClientByIname (String iname)
OxAuthClient	getClientByDisplayName (String DisplayName)
OxAuthCustomClient	getClientByAttributeCustom (String name, String value)
OxAuthApplicationType []	getApplicationType ()
GluuBoolean []	getOxAuthTrustedClient ()
OxAuthSubjectType []	getSubjectTypes ()
SignatureAlgorithm []	getSignatureAlgorithms ()
SignatureAlgorithm []	getSignatureAlgorithmsWithoutNone ()
KeyEncryptionAlgorithm []	getKeyEncryptionAlgorithms ()
BlockEncryptionAlgorithm []	getBlockEncryptionAlgorithms ()
AuthenticationMethod []	getAuthenticationMethods ()

非公開メンバ関数
String	generateInumForNewClientImpl ()

非公開変数類
PersistenceEntryManager	ldapEntryManager
Logger	logger
EncryptionService	encryptionService
OrganizationService	organizationService
AppConfiguration	appConfiguration

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

詳解

Provides operations with clients

著者

Reda Zerrad Date: 06.08.2012

Javier Rojas Blum

バージョン

July 19, 2016

関数詳解

addClient()

void org.gluu.oxtrust.ldap.service.ClientService.addClient ( OxAuthClient  client )

inline

Add new client entry

引数

client

                                                   {
                ldapEntryManager.persist(client);
        }

contains()

boolean org.gluu.oxtrust.ldap.service.ClientService.contains ( String  clientDn )

inline

                                                 {
                return ldapEntryManager.contains(OxAuthClient.class, clientDn);
        }

generateInameForNewClient()

String org.gluu.oxtrust.ldap.service.ClientService.generateInameForNewClient ( String  name )

inline

Generate new iname for client

戻り値

New iname for client

                                                             {
                return String.format("%s*clients*%s", appConfiguration.getOrgIname(), name);
        }

generateInumForNewClient()

String org.gluu.oxtrust.ldap.service.ClientService.generateInumForNewClient ( )

inline

Generate new inum for client

戻り値

New inum for client

                                                 {
                OxAuthClient client = new OxAuthClient();
                String newInum = null;
                do {
                        newInum = generateInumForNewClientImpl();
                        String newDn = getDnForClient(newInum);
                        client.setDn(newDn);
                } while (ldapEntryManager.contains(client));

                return newInum;
        }

generateInumForNewClientImpl()

String org.gluu.oxtrust.ldap.service.ClientService.generateInumForNewClientImpl ( )

inlineprivate

Generate new inum for client

戻り値

New inum for client

                                                      {
                String orgInum = organizationService.getInumForOrganization();
                return orgInum + OxTrustConstants.inumDelimiter + "0008" + OxTrustConstants.inumDelimiter
                                + INumGenerator.generate(4);

        }

getAllClients() [1/2]

List<OxAuthClient> org.gluu.oxtrust.ldap.service.ClientService.getAllClients ( int  sizeLimit )

inline

                                                               {
                return ldapEntryManager.findEntries(getDnForClient(null), OxAuthClient.class, null, sizeLimit);
        }

getAllClients() [2/2]

List<OxAuthClient> org.gluu.oxtrust.ldap.service.ClientService.getAllClients ( )

inline

                                                  {
                return ldapEntryManager.findEntries(getDnForClient(null), OxAuthClient.class, null);
        }

getApplicationType()

OxAuthApplicationType [] org.gluu.oxtrust.ldap.service.ClientService.getApplicationType ( )

inline

Get all available Application types

戻り値

Array of Application types

                                                            {
                return OxAuthApplicationType.values();
        }

getAuthenticationMethods()

AuthenticationMethod [] org.gluu.oxtrust.ldap.service.ClientService.getAuthenticationMethods ( )

inline

Get all available Authentication methods

戻り値

Array of Authentication methods

                                                                 {
                return AuthenticationMethod.values();
        }

getBlockEncryptionAlgorithms()

BlockEncryptionAlgorithm [] org.gluu.oxtrust.ldap.service.ClientService.getBlockEncryptionAlgorithms ( )

inline

Get all available Block Encryption Algorithms

戻り値

Array of Block Encryption Algorithms

                                                                         {
                return BlockEncryptionAlgorithm.values();
        }

getClientByAttributeCustom()

OxAuthCustomClient org.gluu.oxtrust.ldap.service.ClientService.getClientByAttributeCustom ( String  name, String  value  )

inline

Get custom client by Attribute

引数

name
value

戻り値

Custom client

                                                                                        {
                try {
                        if (name.equalsIgnoreCase("dn")) {
                                return getClientByDnCustom(value);
                        }
                        if (name.equalsIgnoreCase("inum")) {
                                return getClientByInumCustom(value);
                        }

                        logger.info("creating a new instance of OxAuthCustomClient ");
                        OxAuthCustomClient client = new OxAuthCustomClient();
                        logger.info("getting dn for client ");
                        client.setBaseDn(getDnForClient(null));
                        logger.info("name ", name);
                        logger.info("value ", value);
                        logger.info("setting attribute value ");
                        client.setAttribute(name, value);

                        logger.info("finding entries ");
                        List<OxAuthCustomClient> clients = ldapEntryManager.findEntries(client);

                        if ((clients != null) && (clients.size() > 0)) {
                                logger.info("entry found ");
                                return clients.get(0);
                        }
                        logger.info("no entry ");
                        return null;
                } catch (Exception ex) {
                        logger.error("an error occured ", ex);

                        return null;
                }

        }

getClientByDisplayName()

OxAuthClient org.gluu.oxtrust.ldap.service.ClientService.getClientByDisplayName ( String  DisplayName )

inline

Get client by DisplayName

引数

DisplayName

戻り値

client

例外

Exception

                                                                       {
                OxAuthClient client = new OxAuthClient();
                client.setBaseDn(getDnForClient(null));
                client.setDisplayName(DisplayName);

                List<OxAuthClient> clients = ldapEntryManager.findEntries(client);

                if ((clients != null) && (clients.size() > 0)) {
                        return clients.get(0);
                }

                return null;
        }

getClientByDn()

OxAuthClient org.gluu.oxtrust.ldap.service.ClientService.getClientByDn ( String  Dn )

inline

returns oxAuthClient by Dn

戻り値

oxAuthClient

                                                     {
                OxAuthClient result = ldapEntryManager.find(OxAuthClient.class, Dn);

                return result;
        }

getClientByDnCustom()

OxAuthCustomClient org.gluu.oxtrust.ldap.service.ClientService.getClientByDnCustom ( String  Dn )

inline

returns oxAuthClient by Dn

戻り値

oxAuthClient

                                                                 {
                OxAuthCustomClient result = ldapEntryManager.find(OxAuthCustomClient.class, Dn);

                return result;
        }

getClientByIname()

OxAuthClient org.gluu.oxtrust.ldap.service.ClientService.getClientByIname ( String  iname )

inline

returns oxAuthClient by Dn

戻り値

oxAuthClient Get Client by iname

引数

iname

戻り値

Client

                                                           {
                OxAuthClient client = new OxAuthClient();
                client.setBaseDn(getDnForClient(null));
                client.setIname(iname);

                List<OxAuthClient> clients = ldapEntryManager.findEntries(client);

                if ((clients != null) && (clients.size() > 0)) {
                        return clients.get(0);
                }

                return null;
        }

getClientByInum()

OxAuthClient org.gluu.oxtrust.ldap.service.ClientService.getClientByInum ( String  inum, String...  ldapReturnAttributes  )

inline

Get client by inum

引数

inum	client Inum

戻り値

client

                                                                                         {
                OxAuthClient result = null;
                try {
                        result = ldapEntryManager.find(OxAuthClient.class, getDnForClient(inum), ldapReturnAttributes);
                        
            String encodedClientSecret = result.getEncodedClientSecret(); 
                if (StringHelper.isNotEmpty(encodedClientSecret)) {
                    String clientSecret = encryptionService.decrypt(encodedClientSecret); 
                    result.setOxAuthClientSecret(clientSecret);
                }
                } catch (Exception ex) {
                        logger.debug("Failed to load client entry", ex);
                }
                return result;
        }

getClientByInumCustom()

OxAuthCustomClient org.gluu.oxtrust.ldap.service.ClientService.getClientByInumCustom ( String  inum )

inline

Get custom client by inum

引数

inum	client Inum

戻り値

client

                                                                     {

                OxAuthCustomClient result = ldapEntryManager.find(OxAuthCustomClient.class, getDnForClient(inum));

                return result;
        }

getDnForClient()

String org.gluu.oxtrust.ldap.service.ClientService.getDnForClient ( String  inum )

inline

Build DN string for client

引数

inum	client Inum

戻り値

DN string for specified Client or DN for clients branch if inum is null

                                                  {
                String orgDn = organizationService.getDnForOrganization();
                if (StringHelper.isEmpty(inum)) {
                        return String.format("ou=clients,%s", orgDn);
                }

                return String.format("inum=%s,ou=clients,%s", inum, orgDn);
        }

getKeyEncryptionAlgorithms()

KeyEncryptionAlgorithm [] org.gluu.oxtrust.ldap.service.ClientService.getKeyEncryptionAlgorithms ( )

inline

Get all available Key Encryption Algorithms

戻り値

Array of Key Encryption Algorithms

                                                                     {
                return KeyEncryptionAlgorithm.values();
        }

getOxAuthTrustedClient()

GluuBoolean [] org.gluu.oxtrust.ldap.service.ClientService.getOxAuthTrustedClient ( )

inline

GetOxAuthTrustedClient

戻り値

Array of OxAuthTrustedClient

                                                      {
                return new GluuBoolean[] { GluuBoolean.TRUE, GluuBoolean.FALSE };
        }

getSignatureAlgorithms()

SignatureAlgorithm [] org.gluu.oxtrust.ldap.service.ClientService.getSignatureAlgorithms ( )

inline

Get all available Signature Algorithms

戻り値

Array of Signature Algorithms

                                                             {
                return SignatureAlgorithm.values();
        }

getSignatureAlgorithmsWithoutNone()

SignatureAlgorithm [] org.gluu.oxtrust.ldap.service.ClientService.getSignatureAlgorithmsWithoutNone ( )

inline

                                                                        {
                return new SignatureAlgorithm[] { SignatureAlgorithm.HS256, SignatureAlgorithm.HS384, SignatureAlgorithm.HS512,
                                SignatureAlgorithm.RS256, SignatureAlgorithm.RS384, SignatureAlgorithm.RS512, SignatureAlgorithm.ES256,
                                SignatureAlgorithm.ES384, SignatureAlgorithm.ES512, };
        }

getSubjectTypes()

OxAuthSubjectType [] org.gluu.oxtrust.ldap.service.ClientService.getSubjectTypes ( )

inline

Get all available Subject types

戻り値

Array of Subject types

                                                     {
                return OxAuthSubjectType.values();
        }

removeClient()

void org.gluu.oxtrust.ldap.service.ClientService.removeClient ( OxAuthClient  client )

inline

Remove client entry

引数

client

                                                      {
                ldapEntryManager.removeRecursively(client.getDn());
        }

searchClients()

List<OxAuthClient> org.gluu.oxtrust.ldap.service.ClientService.searchClients ( String  pattern, int  sizeLimit  )

inline

Search clients by pattern

引数

pattern	Pattern
sizeLimit	Maximum count of results

戻り値

List of clients

                                                                               {
                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<OxAuthClient> result = ldapEntryManager.findEntries(getDnForClient(null), OxAuthClient.class, searchFilter,
                                sizeLimit);

                return result;
        }

updateClient()

void org.gluu.oxtrust.ldap.service.ClientService.updateClient ( OxAuthClient  client )

inline

Update client entry

引数

client

Client

                                                      {
                ldapEntryManager.merge(client);
        }

updateCustomClient()

void org.gluu.oxtrust.ldap.service.ClientService.updateCustomClient ( OxAuthCustomClient  client )

inline

Update Custom client entry

引数

client

Client

                                                                  {
                ldapEntryManager.merge(client);
        }

メンバ詳解

appConfiguration

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

private

encryptionService

EncryptionService org.gluu.oxtrust.ldap.service.ClientService.encryptionService

private

ldapEntryManager

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

private

logger

Logger org.gluu.oxtrust.ldap.service.ClientService.logger

private

organizationService

OrganizationService org.gluu.oxtrust.ldap.service.ClientService.organizationService

private

serialVersionUID

final long org.gluu.oxtrust.ldap.service.ClientService.serialVersionUID = 7912416439116338984L

staticprivate

---

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

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