org.xdi.oxd.server.op.RsProtectOperation クラス

org.xdi.oxd.server.op.RsProtectOperation の継承関係図

org.xdi.oxd.server.op.RsProtectOperation 連携図

公開メンバ関数
CommandResponse	execute (final RsProtectParams params) throws Exception
Class< T >	getParameterClass ()
T	getParams ()
Injector	getInjector ()
HttpService	getHttpService ()
IntrospectionService	getIntrospectionService ()
PublicOpKeyService	getKeyService ()
StateService	getStateService ()
LicenseService	getLicenseService ()
DiscoveryService	getDiscoveryService ()
UmaTokenService	getUmaTokenService ()
RpService	getRpService ()
ConfigurationService	getConfigurationService ()
OxAuthCryptoProvider	getCryptoProvider () throws Exception
Rp	getRp ()
ValidationService	getValidationService ()
Command	getCommand ()
CommandResponse	okResponse (IOpResponse p_data)

限定公開メンバ関数
	RsProtectOperation (Command p_command, final Injector injector)

関数
public< T > T	getInstance (Class< T > type)

非公開メンバ関数
void	persist (ResourceRegistrar registrar, Rp site) throws IOException
void	validate (RsProtectParams params)

静的非公開変数類
static final Logger	LOG = LoggerFactory.getLogger(RsProtectOperation.class)

詳解

著者

Yuriy Zabrovarnyy

バージョン

0.9, 31/05/2016

構築子と解体子

RsProtectOperation()

org.xdi.oxd.server.op.RsProtectOperation.RsProtectOperation ( Command  p_command, final Injector  injector  )

inlineprotected

                                                                             {
        super(p_command, injector, RsProtectParams.class);
    }

関数詳解

execute()

CommandResponse org.xdi.oxd.server.op.RsProtectOperation.execute ( final RsProtectParams  params ) throws Exception

inline

                                                                                  {
        validate(params);

        Rp site = getRp();

        PatProvider patProvider = new PatProvider() {
            @Override
            public String getPatToken() {
                return getUmaTokenService().getPat(params.getOxdId()).getToken();
            }

            @Override
            public void clearPat() {
                // do nothing
            }
        };

        ResourceRegistrar registrar = new ResourceRegistrar(patProvider, new ServiceProvider(site.getOpHost()));
        try {
            registrar.register(params.getResources());
        } catch (ClientResponseFailure e) {
            LOG.debug("Failed to register resource. Entity: " + e.getResponse().getEntity(String.class) + ", status: " + e.getResponse().getStatus(), e);
            if (e.getResponse().getStatus() == 400 || e.getResponse().getStatus() == 401) {
                LOG.debug("Try maybe PAT is lost on AS, force refresh PAT and re-try ...");
                getUmaTokenService().obtainPat(params.getOxdId()); // force to refresh PAT
                registrar.register(params.getResources());
            } else {
                throw e;
            }
        }

        persist(registrar, site);

        return okResponse(new RsProtectResponse(site.getOxdId()));
    }

getCommand()

Command org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getCommand ( )

inlineinherited

Returns command

戻り値

command

                                {
        return command;
    }

getConfigurationService()

ConfigurationService org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getConfigurationService ( )

inlineinherited

                                                          {
        return getInstance(ConfigurationService.class);
    }

getCryptoProvider()

OxAuthCryptoProvider org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getCryptoProvider ( ) throws Exception

inlineinherited

                                                                     {
        OxdServerConfiguration conf = getConfigurationService().get();
        return new OxAuthCryptoProvider(conf.getCryptProviderKeyStorePath(), conf.getCryptProviderKeyStorePassword(), conf.getCryptProviderDnName());
    }

getDiscoveryService()

DiscoveryService org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getDiscoveryService ( )

inlineinherited

                                                  {
        return getInstance(DiscoveryService.class);
    }

getHttpService()

HttpService org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getHttpService ( )

inlineinherited

                                        {
        return getInstance(HttpService.class);
    }

getInjector()

Injector org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getInjector ( )

inlineinherited

Gets injector.

戻り値

injector

                                  {
        return injector;
    }

getInstance()

public<T> T org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getInstance ( Class< T >  type )

inlinepackageinherited

                                            {
        return injector.getInstance(type);
    }

getIntrospectionService()

IntrospectionService org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getIntrospectionService ( )

inlineinherited

                                                          {
        return getInstance(IntrospectionService.class);
    }

getKeyService()

PublicOpKeyService org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getKeyService ( )

inlineinherited

                                              {
        return getInstance(PublicOpKeyService.class);
    }

getLicenseService()

LicenseService org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getLicenseService ( )

inlineinherited

                                              {
        return getInstance(LicenseService.class);
    }

getParameterClass()

Class<T> org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getParameterClass ( )

inlineinherited

                                        {
        return parameterClass;
    }

getParams()

T org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getParams ( )

inlineinherited

                         {
        return params;
    }

getRp()

Rp org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getRp ( )

inlineinherited

                      {
        if (params instanceof HasOxdIdParams) {
            getValidationService().validate((HasOxdIdParams) params);
            HasOxdIdParams hasOxdId = (HasOxdIdParams) params;
            return getRpService().getRp(hasOxdId.getOxdId());
        }
        throw new ErrorResponseException(ErrorResponseCode.BAD_REQUEST_NO_OXD_ID);
    }

getRpService()

RpService org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getRpService ( )

inlineinherited

                                    {
        return getInstance(RpService.class);
    }

getStateService()

StateService org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getStateService ( )

inlineinherited

                                          {
        return getInstance(StateService.class);
    }

getUmaTokenService()

UmaTokenService org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getUmaTokenService ( )

inlineinherited

                                                {
        return getInstance(UmaTokenService.class);
    }

getValidationService()

ValidationService org.xdi.oxd.server.op.BaseOperation< T extends IParams >.getValidationService ( )

inlineinherited

                                                    {
        return getInstance(ValidationService.class);
    }

okResponse()

CommandResponse org.xdi.oxd.server.op.BaseOperation< T extends IParams >.okResponse ( IOpResponse  p_data )

inlineinherited

Ok response for operation

引数

p_data

response

戻り値

ok response with data

                                                          {
        if (p_data == null) {
            return CommandResponse.createInternalError();
        }
        return CommandResponse.ok().setData(new POJONode(p_data));
    }

persist()

void org.xdi.oxd.server.op.RsProtectOperation.persist ( ResourceRegistrar  registrar, Rp  site  ) throws IOException

inlineprivate

                                                                                  {
        Map<Key, RsResource> resourceMapCopy = registrar.getResourceMapCopy();

        for (Map.Entry<Key, String> entry : registrar.getIdMapCopy().entrySet()) {
            UmaResource resource = new UmaResource();
            resource.setId(entry.getValue());
            resource.setPath(entry.getKey().getPath());
            resource.setHttpMethods(entry.getKey().getHttpMethods());

            Set<String> scopes = Sets.newHashSet();
            Set<String> scopesForTicket = Sets.newHashSet();
            Set<String> scopeExpressions = Sets.newHashSet();

            RsResource rsResource = resourceMapCopy.get(entry.getKey());

            for (String httpMethod : entry.getKey().getHttpMethods()) {

                List<String> rsScopes = rsResource.scopes(httpMethod);
                if (rsScopes != null) {
                    scopes.addAll(rsScopes);
                }
                scopesForTicket.addAll(rsResource.getScopesForTicket(httpMethod));

                JsonNode scopeExpression = rsResource.getScopeExpression(httpMethod);
                if (scopeExpression != null) {
                    scopeExpressions.add(scopeExpression.toString());
                }
            }

            resource.setScopes(Lists.newArrayList(scopes));
            resource.setTicketScopes(Lists.newArrayList(scopesForTicket));
            resource.setScopeExpressions(Lists.newArrayList(scopeExpressions));

            site.getUmaProtectedResources().add(resource);
        }

        getRpService().update(site);
    }

validate()

void org.xdi.oxd.server.op.RsProtectOperation.validate ( RsProtectParams  params )

inlineprivate

                                                  {
        if (params.getResources() == null || params.getResources().isEmpty()) {
            throw new ErrorResponseException(ErrorResponseCode.NO_UMA_RESOURCES_TO_PROTECT);
        }
        if (!org.xdi.oxd.rs.protect.ResourceValidator.isHttpMethodUniqueInPath(params.getResources())) {
            throw new ErrorResponseException(ErrorResponseCode.UMA_HTTP_METHOD_NOT_UNIQUE);
        }
        if (params.getResources() != null){
            for (RsResource resource : params.getResources()) {
                if (resource.getConditions() != null) {
                    for (Condition condition : resource.getConditions()) {
                        if (condition.getScopeExpression() != null) {
                            String json = condition.getScopeExpression().toString();
                            if (StringUtils.isNotBlank(json)) {
                                boolean nodeValid = JsonLogicNodeParser.isNodeValid(json);
                                LOG.trace("Scope expression validator - Valid: " + nodeValid + ", expression: " + json);
                                if (!nodeValid) {
                                    throw new ErrorResponseException(ErrorResponseCode.UMA_FAILED_TO_VALIDATE_SCOPE_EXPRESSION);
                                }
                            }
                        }
                    }
                }
            }
        }

        Rp rp = getRp();
        List<UmaResource> existingUmaResources = rp.getUmaProtectedResources();
        if (existingUmaResources != null && !existingUmaResources.isEmpty()) {
            if (params.getOverwrite() == null || !params.getOverwrite()) {
                throw new ErrorResponseException(ErrorResponseCode.UMA_PROTECTION_FAILED_BECAUSE_RESOURCES_ALREADY_EXISTS);
            } else {
                // remove existing resources, overwrite=true
                UmaMetadata discovery = getDiscoveryService().getUmaDiscoveryByOxdId(params.getOxdId());
                UmaResourceService resourceService = UmaClientFactory.instance().createResourceService(discovery, getHttpService().getClientExecutor());
                String pat = getUmaTokenService().getPat(params.getOxdId()).getToken();

                for (UmaResource resource : existingUmaResources) {
                    LOG.trace("Removing existing resource " + resource.getId() + " ...");
                    resourceService.deleteResource("Bearer " + pat, resource.getId());
                    LOG.trace("Removed existing resource " + resource.getId() + ".");
                }
                rp.getUmaProtectedResources().clear();
                getRpService().updateSilently(rp);
            }
        }
    }

メンバ詳解

LOG

final Logger org.xdi.oxd.server.op.RsProtectOperation.LOG = LoggerFactory.getLogger(RsProtectOperation.class)

staticprivate

---

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

• D:/AppData/OpenId/gluu/src/oxd/oxd-server/src/main/java/org/xdi/oxd/server/op/RsProtectOperation.java