001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.terminal.region;
018
019/**
020 * A transport-neutral view of who is asking.
021 *
022 * <p>
023 * It carries no bus types: a bridge module adapts its own session type to this interface.
024 */
025public interface TerminalCaller {
026
027   /**
028    * The principal name.
029    *
030    * @return The principal name, or <jk>null</jk> when anonymous.
031    */
032   String principalName();
033
034   /**
035    * An attribute captured when the caller's session opened.
036    *
037    * @param name The attribute name.
038    * @return The attribute value, or <jk>null</jk>.
039    */
040   Object attribute(String name);
041}