/hudson-plugin-utils/src/main/java/org/hudsonci/utils/plugin/ui/AdministratorUIComponent.java

 1/**
 2 * The MIT License
 3 *
 4 * Copyright (c) 2010-2011 Sonatype, Inc. All rights reserved.
 5 *
 6 * Permission is hereby granted, free of charge, to any person obtaining a copy
 7 * of this software and associated documentation files (the "Software"), to deal
 8 * in the Software without restriction, including without limitation the rights
 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25package org.hudsonci.utils.plugin.ui;
26
27import hudson.model.Action;
28import hudson.model.Hudson;
29import hudson.security.Permission;
30
31/**
32 * UI components for administrative activities.
33 * 
34 * The user must be an administrator to view and optionally to submit forms.
35 * 
36 * Subclasses should call the {@link #checkPermission()} before performing any
37 * form actions.
38 *
39 * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
40 * @since 2.1.0
41 */
42public abstract class AdministratorUIComponent<P extends Action>
43    extends UIComponentSupport<P>
44{
45    protected AdministratorUIComponent(final P parent) {
46        super(parent);
47    }
48
49    @Override
50    public Permission getViewPermission() {
51        return Hudson.ADMINISTER;
52    }
53
54    protected void checkPermission() {
55        checkPermission(Hudson.ADMINISTER);
56    }
57}