gluu
公開メンバ関数 | 限定公開メンバ関数 | 限定公開変数類 | 非公開変数類 | 全メンバ一覧
org.xdi.oxauth.service.external.context.ConsentGatheringContext クラス
org.xdi.oxauth.service.external.context.ConsentGatheringContext の継承関係図
Inheritance graph
org.xdi.oxauth.service.external.context.ConsentGatheringContext 連携図
Collaboration graph

公開メンバ関数

 ConsentGatheringContext (Map< String, SimpleCustomProperty > configurationAttributes, HttpServletRequest httpRequest, HttpServletResponse httpResponse, SessionId session, Map< String, String > pageAttributes, ConsentGatheringSessionService sessionService, UserService userService, FacesService facesService, AppConfiguration appConfiguration)
 
Map< String, SimpleCustomProperty > getConfigurationAttributes ()
 
User getUser (String... returnAttributes)
 
String getUserDn ()
 
Client getClient ()
 
Map< String, String > getConnectSessionAttributes ()
 
boolean isAuthenticated ()
 
Map< String, String > getPageAttributes ()
 
Map< String, String[]> getRequestParameters ()
 
int getStep ()
 
void setStep (int step)
 
void addSessionAttribute (String key, String value)
 
void removeSessionAttribute (String key)
 
Map< String, String > getSessionAttributes ()
 
void persist ()
 
UserService getUserService ()
 
FacesService getFacesService ()
 
AppConfiguration getAppConfiguration ()
 
Logger getLog ()
 
PersistenceEntryManager getPersistenceEntryManager ()
 
HttpServletRequest getHttpRequest ()
 
HttpServletResponse getHttpResponse ()
 
String getIpAddress ()
 
boolean isInNetwork (String cidrNotation)
 

限定公開メンバ関数

CustomEntry getEntryByDn (String dn, String ... ldapReturnAttributes)
 
String getEntryAttributeValue (String dn, String attributeName)
 

限定公開変数類

HttpServletRequest httpRequest
 
final HttpServletResponse httpResponse
 

非公開変数類

final ConsentGatheringSessionService sessionService
 
final UserService userService
 
final FacesService facesService
 
final AppConfiguration appConfiguration
 
final Map< String, SimpleCustomProperty > configurationAttributes
 
final SessionId session
 
final Map< String, String > pageAttributes
 

詳解

著者
Yuriy Movchan Date: 10/30/2017

構築子と解体子

◆ ConsentGatheringContext()

org.xdi.oxauth.service.external.context.ConsentGatheringContext.ConsentGatheringContext ( Map< String, SimpleCustomProperty >  configurationAttributes,
HttpServletRequest  httpRequest,
HttpServletResponse  httpResponse,
SessionId  session,
Map< String, String >  pageAttributes,
ConsentGatheringSessionService  sessionService,
UserService  userService,
FacesService  facesService,
AppConfiguration  appConfiguration 
)
inline
40  {
41  super(httpRequest, httpResponse);
43  this.session = session;
46  this.userService = userService;
49  }
final SessionId session
Definition: ConsentGatheringContext.java:35
final AppConfiguration appConfiguration
Definition: ConsentGatheringContext.java:32
final HttpServletResponse httpResponse
Definition: ExternalScriptContext.java:35
final FacesService facesService
Definition: ConsentGatheringContext.java:31
final UserService userService
Definition: ConsentGatheringContext.java:30
final ConsentGatheringSessionService sessionService
Definition: ConsentGatheringContext.java:29
HttpServletRequest httpRequest
Definition: ExternalScriptContext.java:34
final Map< String, SimpleCustomProperty > configurationAttributes
Definition: ConsentGatheringContext.java:34
final Map< String, String > pageAttributes
Definition: ConsentGatheringContext.java:36

関数詳解

◆ addSessionAttribute()

void org.xdi.oxauth.service.external.context.ConsentGatheringContext.addSessionAttribute ( String  key,
String  value 
)
inline
95  {
96  session.getSessionAttributes().put(key, value);
97  }
Map< String, String > getSessionAttributes()
Definition: SessionId.java:196
final SessionId session
Definition: ConsentGatheringContext.java:35

◆ getAppConfiguration()

AppConfiguration org.xdi.oxauth.service.external.context.ConsentGatheringContext.getAppConfiguration ( )
inline
124  {
125  return appConfiguration;
126  }
final AppConfiguration appConfiguration
Definition: ConsentGatheringContext.java:32

◆ getClient()

Client org.xdi.oxauth.service.external.context.ConsentGatheringContext.getClient ( )
inline
63  {
65  }
final SessionId session
Definition: ConsentGatheringContext.java:35
final ConsentGatheringSessionService sessionService
Definition: ConsentGatheringContext.java:29
Client getClient(SessionId session)
Definition: ConsentGatheringSessionService.java:194

◆ getConfigurationAttributes()

Map<String, SimpleCustomProperty> org.xdi.oxauth.service.external.context.ConsentGatheringContext.getConfigurationAttributes ( )
inline
51  {
53  }
final Map< String, SimpleCustomProperty > configurationAttributes
Definition: ConsentGatheringContext.java:34

◆ getConnectSessionAttributes()

Map<String, String> org.xdi.oxauth.service.external.context.ConsentGatheringContext.getConnectSessionAttributes ( )
inline
67  {
68  SessionId connectSession = sessionService.getConnectSession(httpRequest);
69  if (connectSession != null) {
70  return new HashMap<String, String>(connectSession.getSessionAttributes());
71  }
72  return new HashMap<String, String>();
73  }
SessionId getConnectSession(HttpServletRequest httpRequest)
Definition: ConsentGatheringSessionService.java:44
final ConsentGatheringSessionService sessionService
Definition: ConsentGatheringContext.java:29
HttpServletRequest httpRequest
Definition: ExternalScriptContext.java:34

◆ getEntryAttributeValue()

String org.xdi.oxauth.service.external.context.ExternalScriptContext.getEntryAttributeValue ( String  dn,
String  attributeName 
)
inlineprotectedinherited
96  {
97  final CustomEntry entry = getEntryByDn(dn, attributeName);
98  if (entry != null) {
99  final String attributeValue = entry.getCustomAttributeValue(attributeName);
100  return attributeValue;
101  }
102 
103  return "";
104  }
CustomEntry getEntryByDn(String dn, String ... ldapReturnAttributes)
Definition: ExternalScriptContext.java:86

◆ getEntryByDn()

CustomEntry org.xdi.oxauth.service.external.context.ExternalScriptContext.getEntryByDn ( String  dn,
String ...  ldapReturnAttributes 
)
inlineprotectedinherited
86  {
87  try {
88  return ldapEntryManager.find(CustomEntry.class, dn, ldapReturnAttributes);
89  } catch (EntryPersistenceException epe) {
90  log.error("Failed to find entry '{}'", dn);
91  }
92 
93  return null;
94  }
static final Logger log
Definition: ExternalScriptContext.java:31
final PersistenceEntryManager ldapEntryManager
Definition: ExternalScriptContext.java:33

◆ getFacesService()

FacesService org.xdi.oxauth.service.external.context.ConsentGatheringContext.getFacesService ( )
inline
120  {
121  return facesService;
122  }
final FacesService facesService
Definition: ConsentGatheringContext.java:31

◆ getHttpRequest()

HttpServletRequest org.xdi.oxauth.service.external.context.ExternalScriptContext.getHttpRequest ( )
inlineinherited
65  {
66  return httpRequest;
67  }
HttpServletRequest httpRequest
Definition: ExternalScriptContext.java:34

◆ getHttpResponse()

HttpServletResponse org.xdi.oxauth.service.external.context.ExternalScriptContext.getHttpResponse ( )
inlineinherited
69  {
70  return httpResponse;
71  }
final HttpServletResponse httpResponse
Definition: ExternalScriptContext.java:35

◆ getIpAddress()

String org.xdi.oxauth.service.external.context.ExternalScriptContext.getIpAddress ( )
inlineinherited
73  {
74  return httpRequest != null ? httpRequest.getRemoteAddr() : "";
75  }
HttpServletRequest httpRequest
Definition: ExternalScriptContext.java:34

◆ getLog()

Logger org.xdi.oxauth.service.external.context.ExternalScriptContext.getLog ( )
inlineinherited
57  {
58  return log;
59  }
static final Logger log
Definition: ExternalScriptContext.java:31

◆ getPageAttributes()

Map<String, String> org.xdi.oxauth.service.external.context.ConsentGatheringContext.getPageAttributes ( )
inline
79  {
80  return pageAttributes;
81  }
final Map< String, String > pageAttributes
Definition: ConsentGatheringContext.java:36

◆ getPersistenceEntryManager()

PersistenceEntryManager org.xdi.oxauth.service.external.context.ExternalScriptContext.getPersistenceEntryManager ( )
inlineinherited
61  {
62  return ldapEntryManager;
63  }
final PersistenceEntryManager ldapEntryManager
Definition: ExternalScriptContext.java:33

◆ getRequestParameters()

Map<String, String[]> org.xdi.oxauth.service.external.context.ConsentGatheringContext.getRequestParameters ( )
inline
83  {
84  return httpRequest.getParameterMap();
85  }
HttpServletRequest httpRequest
Definition: ExternalScriptContext.java:34

◆ getSessionAttributes()

Map<String, String> org.xdi.oxauth.service.external.context.ConsentGatheringContext.getSessionAttributes ( )
inline
103  {
104  return session.getSessionAttributes();
105  }
Map< String, String > getSessionAttributes()
Definition: SessionId.java:196
final SessionId session
Definition: ConsentGatheringContext.java:35

◆ getStep()

int org.xdi.oxauth.service.external.context.ConsentGatheringContext.getStep ( )
inline
87  {
89  }
final SessionId session
Definition: ConsentGatheringContext.java:35
final ConsentGatheringSessionService sessionService
Definition: ConsentGatheringContext.java:29
int getStep(SessionId session)
Definition: ConsentGatheringSessionService.java:107

◆ getUser()

User org.xdi.oxauth.service.external.context.ConsentGatheringContext.getUser ( String...  returnAttributes)
inline
55  {
56  return sessionService.getUser(httpRequest, returnAttributes);
57  }
User getUser(HttpServletRequest httpRequest, String... returnAttributes)
Definition: ConsentGatheringSessionService.java:175
final ConsentGatheringSessionService sessionService
Definition: ConsentGatheringContext.java:29
HttpServletRequest httpRequest
Definition: ExternalScriptContext.java:34

◆ getUserDn()

String org.xdi.oxauth.service.external.context.ConsentGatheringContext.getUserDn ( )
inline
59  {
61  }
String getUserDn(HttpServletRequest httpRequest)
Definition: ConsentGatheringSessionService.java:184
final ConsentGatheringSessionService sessionService
Definition: ConsentGatheringContext.java:29
HttpServletRequest httpRequest
Definition: ExternalScriptContext.java:34

◆ getUserService()

UserService org.xdi.oxauth.service.external.context.ConsentGatheringContext.getUserService ( )
inline
116  {
117  return userService;
118  }
final UserService userService
Definition: ConsentGatheringContext.java:30

◆ isAuthenticated()

boolean org.xdi.oxauth.service.external.context.ConsentGatheringContext.isAuthenticated ( )
inline
75  {
76  return getUser() != null;
77  }
User getUser(String... returnAttributes)
Definition: ConsentGatheringContext.java:55

◆ isInNetwork()

boolean org.xdi.oxauth.service.external.context.ExternalScriptContext.isInNetwork ( String  cidrNotation)
inlineinherited
77  {
78  final String ip = getIpAddress();
79  if (Util.allNotBlank(ip, cidrNotation)) {
80  final SubnetUtils utils = new SubnetUtils(cidrNotation);
81  return utils.getInfo().isInRange(ip);
82  }
83  return false;
84  }
String getIpAddress()
Definition: ExternalScriptContext.java:73

◆ persist()

void org.xdi.oxauth.service.external.context.ConsentGatheringContext.persist ( )
inline

Must not take any parameters

110  {
112 
114  }
Map< String, String > getSessionAttributes()
Definition: SessionId.java:196
final SessionId session
Definition: ConsentGatheringContext.java:35
boolean persist(SessionId session)
Definition: ConsentGatheringSessionService.java:94
final ConsentGatheringSessionService sessionService
Definition: ConsentGatheringContext.java:29
final Map< String, String > pageAttributes
Definition: ConsentGatheringContext.java:36

◆ removeSessionAttribute()

void org.xdi.oxauth.service.external.context.ConsentGatheringContext.removeSessionAttribute ( String  key)
inline
99  {
100  session.getSessionAttributes().remove(key);
101  }
Map< String, String > getSessionAttributes()
Definition: SessionId.java:196
final SessionId session
Definition: ConsentGatheringContext.java:35

◆ setStep()

void org.xdi.oxauth.service.external.context.ConsentGatheringContext.setStep ( int  step)
inline
91  {
93  }
final SessionId session
Definition: ConsentGatheringContext.java:35
final ConsentGatheringSessionService sessionService
Definition: ConsentGatheringContext.java:29
void setStep(int step, SessionId session)
Definition: ConsentGatheringSessionService.java:117

メンバ詳解

◆ appConfiguration

final AppConfiguration org.xdi.oxauth.service.external.context.ConsentGatheringContext.appConfiguration
private

◆ configurationAttributes

final Map<String, SimpleCustomProperty> org.xdi.oxauth.service.external.context.ConsentGatheringContext.configurationAttributes
private

◆ facesService

final FacesService org.xdi.oxauth.service.external.context.ConsentGatheringContext.facesService
private

◆ httpRequest

HttpServletRequest org.xdi.oxauth.service.external.context.ExternalScriptContext.httpRequest
protectedinherited

◆ httpResponse

final HttpServletResponse org.xdi.oxauth.service.external.context.ExternalScriptContext.httpResponse
protectedinherited

◆ pageAttributes

final Map<String, String> org.xdi.oxauth.service.external.context.ConsentGatheringContext.pageAttributes
private

◆ session

final SessionId org.xdi.oxauth.service.external.context.ConsentGatheringContext.session
private

◆ sessionService

final ConsentGatheringSessionService org.xdi.oxauth.service.external.context.ConsentGatheringContext.sessionService
private

◆ userService

final UserService org.xdi.oxauth.service.external.context.ConsentGatheringContext.userService
private

このクラス詳解は次のファイルから抽出されました: