org.mitre.oauth2.web.ScopeAPI クラス

org.mitre.oauth2.web.ScopeAPI 連携図

公開メンバ関数
String	getAll (ModelMap m)
String	getScope (@PathVariable("id") Long id, ModelMap m)
String	updateScope (@PathVariable("id") Long id, @RequestBody String json, ModelMap m)
String	createScope (@RequestBody String json, ModelMap m)
String	deleteScope (@PathVariable("id") Long id, ModelMap m)

静的公開変数類
static final String	URL = RootController.API_URL + "/scopes"

非公開変数類
SystemScopeService	scopeService
Gson	gson = new Gson()

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

詳解

著者

jricher

関数詳解

createScope()

String org.mitre.oauth2.web.ScopeAPI.createScope ( @RequestBody String  json, ModelMap  m  )

inline

                                                                        {
                SystemScope scope = gson.fromJson(json, SystemScope.class);

                SystemScope alreadyExists = scopeService.getByValue(scope.getValue());
                if (alreadyExists != null) {
                        //Error, cannot save a scope with the same value as an existing one
                        logger.error("Error: attempting to save a scope with a value that already exists: " + scope.getValue());
                        m.put(HttpCodeView.CODE, HttpStatus.CONFLICT);
                        m.put(JsonErrorView.ERROR_MESSAGE, "A scope with value " + scope.getValue() + " already exists, please choose a different value.");
                        return JsonErrorView.VIEWNAME;
                }

                scope = scopeService.save(scope);

                if (scope != null && scope.getId() != null) {

                        m.put(JsonEntityView.ENTITY, scope);

                        return JsonEntityView.VIEWNAME;
                } else {

                        logger.error("createScope failed; JSON was invalid: " + json);
                        m.put(HttpCodeView.CODE, HttpStatus.BAD_REQUEST);
                        m.put(JsonErrorView.ERROR_MESSAGE, "Could not save new scope " + scope + ". The scope service failed to return a saved entity.");
                        return JsonErrorView.VIEWNAME;

                }
        }

deleteScope()

String org.mitre.oauth2.web.ScopeAPI.deleteScope ( @PathVariable("id") Long  id, ModelMap  m  )

inline

                                                                           {
                SystemScope existing = scopeService.getById(id);

                if (existing != null) {

                        scopeService.remove(existing);

                        return HttpCodeView.VIEWNAME;
                } else {

                        logger.error("deleteScope failed; scope with id " + id + " not found.");
                        m.put(HttpCodeView.CODE, HttpStatus.NOT_FOUND);
                        m.put(JsonErrorView.ERROR_MESSAGE, "Could not delete scope. The requested scope with id " + id + " could not be found.");
                        return JsonErrorView.VIEWNAME;
                }
        }

getAll()

String org.mitre.oauth2.web.ScopeAPI.getAll ( ModelMap  m )

inline

                                         {

                Set<SystemScope> allScopes = scopeService.getAll();

                m.put(JsonEntityView.ENTITY, allScopes);

                return JsonEntityView.VIEWNAME;
        }

getScope()

String org.mitre.oauth2.web.ScopeAPI.getScope ( @PathVariable("id") Long  id, ModelMap  m  )

inline

                                                                        {

                SystemScope scope = scopeService.getById(id);

                if (scope != null) {

                        m.put(JsonEntityView.ENTITY, scope);

                        return JsonEntityView.VIEWNAME;
                } else {

                        logger.error("getScope failed; scope not found: " + id);

                        m.put(HttpCodeView.CODE, HttpStatus.NOT_FOUND);
                        m.put(JsonErrorView.ERROR_MESSAGE, "The requested scope with id " + id + " could not be found.");
                        return JsonErrorView.VIEWNAME;
                }
        }

updateScope()

String org.mitre.oauth2.web.ScopeAPI.updateScope ( @PathVariable("id") Long  id, @RequestBody String  json, ModelMap  m  )

inline

                                                                                                     {

                SystemScope existing = scopeService.getById(id);

                SystemScope scope = gson.fromJson(json, SystemScope.class);

                if (existing != null && scope != null) {

                        if (existing.getId().equals(scope.getId())) {
                                // sanity check

                                scope = scopeService.save(scope);

                                m.put(JsonEntityView.ENTITY, scope);

                                return JsonEntityView.VIEWNAME;
                        } else {

                                logger.error("updateScope failed; scope ids to not match: got "
                                                + existing.getId() + " and " + scope.getId());

                                m.put(HttpCodeView.CODE, HttpStatus.BAD_REQUEST);
                                m.put(JsonErrorView.ERROR_MESSAGE, "Could not update scope. Scope ids to not match: got "
                                                + existing.getId() + " and " + scope.getId());
                                return JsonErrorView.VIEWNAME;
                        }

                } else {

                        logger.error("updateScope failed; scope with id " + id + " not found.");
                        m.put(HttpCodeView.CODE, HttpStatus.NOT_FOUND);
                        m.put(JsonErrorView.ERROR_MESSAGE, "Could not update scope. The scope with id " + id + " could not be found.");
                        return JsonErrorView.VIEWNAME;
                }
        }

メンバ詳解

gson

Gson org.mitre.oauth2.web.ScopeAPI.gson = new Gson()

private

logger

final Logger org.mitre.oauth2.web.ScopeAPI.logger = LoggerFactory.getLogger(ScopeAPI.class)

staticprivate

Logger for this class

scopeService

SystemScopeService org.mitre.oauth2.web.ScopeAPI.scopeService

private

URL

final String org.mitre.oauth2.web.ScopeAPI.URL = RootController.API_URL + "/scopes"

static

---

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

• D:/AppData/OpenId/mitreid-connect/src/openid-connect-server/src/main/java/org/mitre/oauth2/web/ScopeAPI.java