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