001/*
002 * Copyright 2012-2018 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.actuate.autoconfigure.cloudfoundry;
018
019import java.util.Arrays;
020import java.util.List;
021
022/**
023 * The specific access level granted to the cloud foundry user that's calling the
024 * endpoints.
025 *
026 * @author Madhura Bhave
027 * @since 2.0.0
028 */
029public enum AccessLevel {
030
031        /**
032         * Restricted access to a limited set of endpoints.
033         */
034        RESTRICTED("", "health", "info"),
035
036        /**
037         * Full access to all endpoints.
038         */
039        FULL;
040
041        public static final String REQUEST_ATTRIBUTE = "cloudFoundryAccessLevel";
042
043        private final List<String> ids;
044
045        AccessLevel(String... ids) {
046                this.ids = Arrays.asList(ids);
047        }
048
049        /**
050         * Returns if the access level should allow access to the specified ID.
051         * @param id the ID to check
052         * @return {@code true} if access is allowed
053         */
054        public boolean isAccessAllowed(String id) {
055                return this.ids.isEmpty() || this.ids.contains(id);
056        }
057
058}