001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * docs/licenses/cddl.txt 011 * or http://www.opensource.org/licenses/cddl1.php. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * docs/licenses/cddl.txt. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2016-2018 Ping Identity Corporation 026 */ 027 028package com.unboundid.directory.sdk.broker.types; 029 030import com.unboundid.util.NotExtensible; 031 032import javax.servlet.http.HttpServletRequest; 033 034/** 035 * Represents a status request to be processed by a Server SDK Identity 036 * Authenticator. 037 */ 038@NotExtensible 039public interface StatusRequest 040{ 041 /** 042 * Retrieve the currently authenticated principal or 043 * {@code null} if not available. 044 * 045 * @return The currently authenticated principal or 046 * {@code null} if not available. 047 */ 048 ScimResourcePrincipal getPrincipal(); 049 050 051 052 /** 053 * Retrieve a JSON object specifying the flow state parameters. 054 * Never {@code null}. 055 * This string can be parsed using any JSON library. For example, 056 * Jackson's ObjectMapper.readTree() or the UnboundID LDAP SDK's JSONObject 057 * constructor. 058 * 059 * @return A JSON object specifying the flow state parameters. 060 */ 061 String getStateParameters(); 062 063 064 065 /** 066 * Retrieve the HTTP servlet request for the request being processed. 067 * @return The HTTP servlet request for the request being processed. 068 */ 069 HttpServletRequest getHttpServletRequest(); 070}