|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.social.greenhouse.GreenhouseTemplate
public class GreenhouseTemplate
This is the central class for interacting with Greenhouse.
Greenhouse operations require OAuth authentication with the server. Therefore, GreenhouseTemplate must be constructed with the minimal information required to sign requests with and OAuth 1 Authorization header.
Constructor Summary | |
---|---|
GreenhouseTemplate(java.lang.String apiKey,
java.lang.String apiSecret,
java.lang.String accessToken,
java.lang.String accessTokenSecret)
Constructs a GreenhouseTemplate with the minimal amount of information required to sign requests with an OAuth 1 Authorization header. |
|
GreenhouseTemplate(java.lang.String apiKey,
java.lang.String apiSecret,
java.lang.String accessToken,
java.lang.String accessTokenSecret,
java.lang.String baseUrl)
Constructs a GreenhouseTemplate with the minimal amount of information required to sign requests with an OAuth 1 Authorization header. |
Method Summary | |
---|---|
java.util.List<Event> |
getEventsAfter(java.util.Date date)
Retrieve a list of events that take place after a given time. |
java.util.List<EventSession> |
getSessionsOnDay(long eventId,
java.util.Date date)
Retrieves a list of sessions for an event that take place on a given day. |
java.util.List<Event> |
getUpcomingEvents()
Retrieve a list of upcoming events. |
GreenhouseProfile |
getUserProfile()
Retrieve the current user's Greenhouse profile information. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GreenhouseTemplate(java.lang.String apiKey, java.lang.String apiSecret, java.lang.String accessToken, java.lang.String accessTokenSecret)
Constructs a GreenhouseTemplate with the minimal amount of information required to sign requests with an OAuth 1 Authorization header.
This constructor assumes that the application will be conversing with the production Greenhouse server at http://springsource.greenhouse.org.
apiKey
- The application's API Key as assigned when registering the
application with GreenhouseapiSecret
- The application's API Secret as assigned when registering the
application with GreenhouseaccessToken
- An access token acquired through successful OAuth 1
authentication with GreenhouseaccessTokenSecret
- An access token secret acquired through successful OAuth 1
authentication with Greenhousepublic GreenhouseTemplate(java.lang.String apiKey, java.lang.String apiSecret, java.lang.String accessToken, java.lang.String accessTokenSecret, java.lang.String baseUrl)
Constructs a GreenhouseTemplate with the minimal amount of information required to sign requests with an OAuth 1 Authorization header.
This constructor allows the application to specify the base URL of the Greenhouse server, enabling the template to converse with a development or test server.
apiKey
- The application's API Key as assigned when registering the
application with GreenhouseapiSecret
- The application's API Secret as assigned when registering the
application with GreenhouseaccessToken
- An access token acquired through successful OAuth 1
authentication with GreenhouseaccessTokenSecret
- An access token secret acquired through successful OAuth 1
authentication with GreenhousebaseUrl
- The base URL of the Greenhouse serverMethod Detail |
---|
public GreenhouseProfile getUserProfile()
GreenhouseOperations
getUserProfile
in interface GreenhouseOperations
public java.util.List<Event> getUpcomingEvents()
GreenhouseOperations
getUpcomingEvents
in interface GreenhouseOperations
public java.util.List<Event> getEventsAfter(java.util.Date date)
GreenhouseOperations
getEventsAfter
in interface GreenhouseOperations
date
- the starting point used to filter the list of events.
public java.util.List<EventSession> getSessionsOnDay(long eventId, java.util.Date date)
GreenhouseOperations
getSessionsOnDay
in interface GreenhouseOperations
eventId
- the ID of the eventdate
- the day to retrieve events for
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |