summaryrefslogtreecommitdiff
path: root/src/com/sun/apoc/templates/handler/HandlerContext.java
blob: c8eefe5280ef62527fed8eccd0d0234394bd07c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either
 * the GNU General Public License Version 2 only ("GPL") or
 * the Common Development and Distribution License("CDDL")
 * (collectively, the "License"). You may not use this file
 * except in compliance with the License. You can obtain a copy
 * of the License at www.sun.com/CDDL or at COPYRIGHT. See the
 * License for the specific language governing permissions and
 * limitations under the License. When distributing the software,
 * include this License Header Notice in each file and include
 * the License file at /legal/license.txt. If applicable, add the
 * following below the License Header, with the fields enclosed
 * by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by
 * only the CDDL or only the GPL Version 2, indicate your
 * decision by adding "[Contributor] elects to include this
 * software in this distribution under the [CDDL or GPL
 * Version 2] license." If you don't indicate a single choice
 * of license, a recipient has the option to distribute your
 * version of this file under either the CDDL, the GPL Version
 * 2 or to extend the choice of license to its licensees as
 * provided above. However, if you add GPL Version 2 code and
 * therefore, elected the GPL Version 2 license, then the
 * option applies only if the new code is made subject to such
 * option by the copyright holder.
 */


package com.sun.apoc.templates.handler;
import com.iplanet.jato.RequestManager;
import com.sun.apoc.manager.Constants;
import com.sun.apoc.manager.profiles.ProfileWindowModel;
import com.sun.apoc.manager.settings.PolicyMgrHelper;
import com.sun.apoc.spi.SPIException;
import com.sun.web.ui.common.CCI18N;
import java.util.Iterator;
import java.util.LinkedList;


/**
 * A context object which provides the information required by a developer to 
 * implement a custom ActionHandler. 
 * <p> The context provides a list of ActionHandlerProperty objects 
 * corresponding to the properties which use the specified ActionHandler. 
 * It also provides the PolicyMgrHelper object - a helper object for 
 * performing backend operations.
 */

public class HandlerContext {
    
    private ProfileWindowModel mEditorModel = null;
    private LinkedList mProperties = null;
    
    public HandlerContext(LinkedList properties) {
        mProperties = properties;
    }

    /**
     * Returns the PolicyMgrHelper object for this Profile.
     *
     * @throws   <code>SPIException</code> if error occurs
     */     
    public PolicyMgrHelper getPolicyMgrHelper() throws SPIException {
        return getEditorModel().getProfileHelper();
    }

    /**
     * Returns an iterator of ActionHandlerProperty's that require the 
     * ActionHandler in question.
     *
     * @throws   <code>SPIException</code> if error occurs
     */  
    public Iterator getProperties() throws SPIException {
        return mProperties.iterator();
    }
    
    public String getLocalizedUndefinedValue() {
        CCI18N i18n = new CCI18N(RequestManager.getRequestContext(), Constants.RES_BASE_NAME);
        String localizedNotSet = i18n.getMessage("APOC.settings.notset");
        if (localizedNotSet.equals("APOC.settings.notset")) {
            localizedNotSet = "-- Not Set --";
        }
        return localizedNotSet;
    }
    
    private ProfileWindowModel getEditorModel() {
        if (mEditorModel == null) {
            mEditorModel = (ProfileWindowModel) RequestManager.getRequestContext().getModelManager().getModel(ProfileWindowModel.class);
        }
        return mEditorModel;
    }
}