1 /* 2 * Copyright [2007] [University Corporation for Advanced Internet Development, Inc.] 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package edu.internet2.middleware.shibboleth.common.xmlobject; 18 19 import javax.xml.namespace.QName; 20 21 import org.opensaml.common.SAMLObject; 22 23 import edu.internet2.middleware.shibboleth.common.config.attribute.encoding.AttributeEncoderNamespaceHandler; 24 25 /** 26 * Represents a string value that contains an attribute containing a scope. 27 */ 28 public interface ShibbolethScopedValue extends SAMLObject { 29 30 /** Local name of the XSI type. */ 31 public static final String TYPE_LOCAL_NAME = "ScopedValue"; 32 33 /** QName of the XSI type. */ 34 public static final QName TYPE_NAME = new QName(AttributeEncoderNamespaceHandler.NAMESPACE, TYPE_LOCAL_NAME, 35 "encoder"); 36 37 /** 38 * Gets the name of the scope attribute. 39 * 40 * @return name of the scope attribute 41 */ 42 public String getScopeAttributeName(); 43 44 /** 45 * Sets the name of the scope attribute. 46 * 47 * @param attribute name of the scope attribute 48 */ 49 public void setScopeAttributeName(String attribute); 50 51 /** 52 * Gets the scope value. 53 * 54 * @return scope value 55 */ 56 public String getScope(); 57 58 /** 59 * Sets the scope value. 60 * 61 * @param scope scope value 62 */ 63 public void setScope(String scope); 64 65 /** 66 * Set the attribute value. 67 * 68 * @param newContent the new attribute value 69 */ 70 public void setValue(String newContent); 71 72 /** 73 * Get the attribute value. 74 * 75 * @return the attribute value. 76 */ 77 public String getValue(); 78 }