-
Notifications
You must be signed in to change notification settings - Fork 25
/
store_finder.go
36 lines (32 loc) · 1.71 KB
/
store_finder.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// Copyright 2015-present, Cyrill @ Schumacher.fm and the CoreStore contributors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package jwt
import "github.com/corestoreio/pkg/store/scope"
// StoreCodeFieldName defines the key in the claim where the store code has been
// stored. Can be overwritten with the scoped configuration.
const StoreCodeFieldName = `store`
// StoreFinder see store.Finder for a description. This interface gets used in
// the WithRunMode() middleware.
type StoreFinder interface {
// DefaultStoreID returns the default active store ID and its website ID
// depending on the run mode. Error behaviour is mostly of type NotValid.
DefaultStoreID(runMode scope.TypeID) (websiteID, storeID uint32, err error)
// StoreIDbyCode returns, depending on the runMode, for a storeCode its
// active store ID and its website ID. An empty runMode hash falls back to
// select the default website, with its default group, and the slice of
// default stores. A not-found error behaviour gets returned if the code
// cannot be found. If the runMode equals to scope.DefaultTypeID, the
// returned ID is always 0 and error is nil.
StoreIDbyCode(runMode scope.TypeID, storeCode string) (websiteID, storeID uint32, err error)
}